All Docs

Getting Started

Get ShipKit up and running in under 10 minutes.

Prerequisites

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

  • Node.js 20.x or later
  • npm or pnpm package manager
  • MongoDB instance (local or Atlas)
  • Git for version control

Quick Start

1. Clone the Repository

git clone https://github.com/SaaS-Developer-Template/org-based-saas-developer-template.git my-saas
cd my-saas

2. Install Dependencies

npm install

3. Set Up Environment Variables

cp .env.example .env.local

Open .env.local and fill in the required values:

  • DATABASE_URL — Your MongoDB connection string
  • NEXTAUTH_SECRET — A random secret for NextAuth.js (generate with openssl rand -base64 32)
  • NEXTAUTH_URL — Your app URL (e.g., http://localhost:3000)

4. Set Up the Database

npx prisma generate
npx prisma db push
npm run seed

5. Start Development Server

npm run dev

Your app is now running at http://localhost:3000.

Next Steps

NextProject Structure