Setup

This guide will walk you through the steps to set up your project locally and start developing.

Step 1: Clone the Repository

Clone the project to your local machine:

git clone <your-repo-url> my-saas-app
cd my-saas-app

Step 2: Install Dependencies

We use npm for dependency management:

npm install

Step 3: Database Setup

1. Make sure you have PostgreSQL running. We provide a docker-compose.yml for convenience:

npm run docker:up

2. The database is automatically created by Docker Compose. If you're using a local PostgreSQL installation, create the database:

createdb database

3. Update DATABASE_URL in .env to match your local setup:

# For Docker (default):
DATABASE_URL="postgresql://postgres:password@localhost:5432/database"

# For local PostgreSQL:
DATABASE_URL="postgresql://your_user:your_password@localhost:5432/database"

4. Run migrations:

# Generate and apply migrations:
npm run db:push

# Or if you prefer to use migrations:
npm run db:migrate

Step 4: Start Development Server

npm run dev

Open http://localhost:3000 - your app is running!

Step 5: Create Your First Account

1. Go to http://localhost:3000/auth/sign-up
2. Enter your name, email and password
3. Since email is not configured yet, check the console for the verification link
4. Click the link to verify your email
5. You're in!

Step 6: Make Yourself an Admin

The first user should be a platform admin to access the admin dashboard (/dashboard/admin).

Option A: Using Drizzle Studio (Recommended)

# Open Drizzle Studio
npm run db:studio

1. Open https://local.drizzle.studio in your browser
2. Click on the user table
3. Find your user and click to edit
4. Change role from user to admin
5. Save

Option B: Using SQL directly

# If using Docker (container name may vary based on directory name):
docker compose exec postgres psql -U postgres -d database

# If using local PostgreSQL:
psql -d database

# Then run:
UPDATE "user" SET role = 'admin' WHERE email = 'your@email.com';
\q

Now you can access the admin panel at http://localhost:3000/dashboard/admin.