Quick Start

Let's get your SaaS project up and running with this production-ready Nuxt boilerplate. You'll have a fully working local environment in just a few minutes.

Prerequisites

Here's what you'll need to get started:

  • Node.js (v20 recommended)
  • pnpm (I strongly recommend using pnpm, though other package managers work too)
  • Git

Installation Steps

1. Clone the Repository

# Using HTTPS
git clone https://github.com/saas-boilerplate/nuxt.git your-project-name

# Or using SSH
git clone git@github.com:saas-boilerplate/nuxt.git your-project-name

cd your-project-name

2. Configure Environment Variables

cp .env.example .env

I've set up the default configuration to work out of the box for development. You can customize the values later—I've created separate guides for each configuration option.

3. Install Dependencies

pnpm i

4. Set Up the Database

For development, we use PostgreSQL with Docker for simplicity and consistency across environments.

Using Docker (Recommended)

  1. First, install Docker on your machine: Docker Installation Guide
  2. Start PostgreSQL server:
docker run --name postgres -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 -d postgres -v saas_data:/var/lib/postgresql/data

The default .env configuration is already set up to work with these PostgreSQL settings. If you need to use different database credentials, update your .env file accordingly.

Initialize Database

Run these commands to set up your database schema and seed initial data:

# Generate and apply database migrations
pnpx prisma migrate dev --name init

# Seed initial data (team plans, roles, etc.)
pnpx tsx server/scripts/seed.ts

The migrations will create a migrations folder in your project. Make sure to commit this to your Git repository as it maintains your database schema history.

5. Start Development Server

pnpm run dev

You should now have a local version running at http://localhost:3000—a full clone of this website!

Next Steps

Setting Up Your Own Repository

Here's how to point the repo to your own:

git remote remove origin
git remote add origin your-git-repository-remote

What's Next?