Getting Started

Welcome to our SaaS Starter Template! This guide will help you get up and running quickly.

Prerequisites

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

• Node.js 18.0 or later
• pnpm 8.0 or later (recommended) or npm/yarn
• Git for version control

Quick Start

1. Clone the Repository

git clone https://github.com/your-org/saas-starter-template.git
cd saas-starter-template

2. Install Dependencies

pnpm install

3. Set Up Environment Variables

Copy the example environment file and configure your settings:

cp .env.example .env.local

Edit .env.local with your configuration:

# Database
DATABASE_URL="your-database-url"

# Authentication
BETTER_AUTH_SECRET="your-secret-key"
BETTER_AUTH_URL="http://localhost:3000"

# Payment (Stripe or Creem)
STRIPE_SECRET_KEY="sk_test_..."
STRIPE_WEBHOOK_SECRET="whsec_..."

4. Initialize the Database

pnpm db:push
pnpm db:seed

5. Start the Development Server

pnpm dev

Open http://localhost:3000 in your browser to see your application.

Project Structure

├── content/           # Blog and documentation content
├── public/            # Static assets
├── src/
│   ├── app/          # Next.js App Router pages
│   ├── components/   # React components
│   ├── lib/          # Utility functions and services
│   ├── hooks/        # Custom React hooks
│   └── i18n/         # Internationalization config
├── drizzle/          # Database migrations
└── scripts/          # Utility scripts

Next Steps

Now that you have the template running, explore these guides:

• Authentication - Set up user authentication
• Payments - Configure payment processing
• Deployment - Deploy to production

Need Help?

If you run into any issues:

1. Check our FAQ for common questions
2. Search existing GitHub Issues
3. Join our Discord community