Getting Started

Get up and running in under 5 minutes.

# Prerequisites

Before you begin, make sure you have the following installed and ready:

• -- Node.js 20+ — nodejs.org
• -- PostgreSQL — local install or managed (Neon, Supabase, Railway)
• -- Stripe account — stripe.com (free to create, use test mode)
• -- Clerk account — clerk.com (free tier available)
• -- Resend account — resend.com (3,000 emails/month free)

# Installation

Clone the repository and install dependencies:

git clone <your-repo>
cd saas-starter
npm install

Create your environment file:

cp .env.example .env

# Environment Variables

Fill in all variables in your .env file. Here is a complete reference:

# Database Setup

Push the Prisma schema to your PostgreSQL database:

# Quick push (development)
npx prisma db push

# Or create a proper migration (recommended for production)
npx prisma migrate dev --name init

Optionally seed the database with initial data:

npx prisma db seed

You can browse your data with Prisma Studio:

npx prisma studio

# Run Dev Server

npm run dev

Open http://localhost:3000 in your browser.

# Project Structure

src/
├── app/
│   ├── (auth)/          # Sign-in, Sign-up (Clerk)
│   ├── (marketing)/     # Landing, Blog, Pricing
│   ├── dashboard/       # Protected dashboard pages
│   ├── admin/           # Admin panel (users, metrics)
│   └── api/             # API routes + webhooks
├── components/
│   ├── ui/              # Reusable UI components
│   ├── landing/         # Landing page sections
│   ├── dashboard/       # Dashboard components
│   └── shared/          # Shared components
├── lib/                 # Utilities, config, helpers
└── styles/              # Global styles + CSS variables

prisma/
├── schema.prisma        # Database schema
└── seed.ts              # Seed script

content/
└── blog/                # MDX blog posts

# Available Scripts

# Next Steps