Getting Started

Goal: cloned repo, working Supabase project, Stripe test keys, and a workspace you can log into locally. Most people get there in one sitting if env vars are ready.

Quick start (5 steps)

1. Install and run locally

git clone https://github.com/your-org/saasforge-core my-app
cd my-app
pnpm install
cp .env.local.example .env.local

Fill in the required environment variables in .env.local (see Installation for details).

2. Set up Supabase

Create a Supabase project and run the SQL migrations in order:

1. supabase/001_schema.sql -- Core tables (workspaces, products, memberships, etc.)
2. supabase/002_rls.sql -- Row-Level Security policies
3. supabase/003_soft_delete_and_dashboard.sql -- Soft delete and analytics
4. supabase/004_onboarding.sql -- Onboarding flag
5. supabase/005_tags_comments_2fa.sql -- Tags, comments, 2FA
6. supabase/006_remaining_features.sql -- API keys, webhooks, custom fields, and more

See Supabase Setup for the detailed walkthrough.

3. Start the dev server

pnpm dev

Visit http://localhost:3000 to see the marketing landing page.

4. Create your first account

1. Go to /sign-up and create an account
2. Confirm your email (or disable confirmation in Supabase for local dev)
3. Sign in and you'll be redirected to /select-workspace
4. Click Create workspace and give it a name
5. You're in! Explore the dashboard, products, and settings

5. Customize your brand

At minimum, update these files to make it yours:

• src/config/brand.ts -- product name, company name, emails, social links
• public/ -- replace logo assets (light, dark, mobile variants)
• src/config/ui/branding.ts -- logo paths

See Customization and White Label Checklist for the full list.

Optional setup

Enable billing (Stripe)

Configure Stripe to enable subscription plans, checkout, and the customer portal.

• Stripe Setup

Enable email invitations (Resend)

Configure Resend to send workspace invitation emails.

• Resend Setup

Without Resend configured, invitations are still created in the database -- you just won't get emails.

What to explore next