Skip to content

Files

Latest commit

 

History

History
104 lines (69 loc) · 1.79 KB

README.md

File metadata and controls

104 lines (69 loc) · 1.79 KB

Stacks 🚀

A modern full-stack development platform for building robust web applications.

Features 🔥

  • 🔶 SvelteKit for frontend and backend
  • 🔒 Authentication with Lucia
  • 🗃️ Database with Drizzle ORM
  • 🎨 UI components with TailwindCSS and Shadcn
  • 📁 File storage with Supabase
  • 📊 Analytics with PostHog

Prerequisites 🛠️

  • Node.js 18+ or Bun 1.0+
  • Docker (optional, for local database)

Installation 📥

# Clone the repository
git clone https://github.com/yourusername/stacks.git
cd stacks

# Install dependencies
npm install
# or with Bun
bun install

Configuration ⚙️

  1. Copy example environment variables
cp .env.example .env
  1. Update the .env file with your configuration

Development 💻

Start the development server:

npm run dev
# or with Bun
bun run dev

Your app will be running at http://localhost:5173

Database Setup 🗄️

Option 1: Docker (recommended)

# Start PostgreSQL
docker-compose -f docker/postgres.yml up -d

# Run migrations
npm run db:migrate

Option 2: Use your own database

Update the DATABASE_URL in your .env file to point to your database.

Testing ✅

# Run unit tests
npm run test

# Run E2E tests with Playwright
npm run test:e2e

Building for Production 🏗️

npm run build

Deployment 🚢

The project is compatible with Vercel, Netlify, and other SvelteKit-compatible hosting platforms.

# Deploy to Vercel
vercel

Documentation 📚

Additional documentation can be found in the docs/ directory.

License 📄

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing 🤝

Contributions are welcome! Please feel free to submit a Pull Request.