NeoSaaSNeoSaaS
Docs

Installation

Learn how to install and set up NeoSaaS for your project

Documentation/Installation

Prerequisites

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

  • Node.js 18.0 or higher
  • npm 8.0 or higher (or yarn/pnpm)
  • Git (for cloning the repository)

Step 1: Download from GitHub

Download the latest version of NeoSaaS from the official GitHub repository at https://github.com/neosaastech/neosaas

Clone the repository using Git:

git clone https://github.com/neosaastech/neosaas.git

Then navigate to the project directory:

cd neosaas

Step 2: Install Node Dependencies

Install all required Node.js packages using npm:

npm install

This will install Next.js 16, Tailwind CSS, Prisma, and all other dependencies defined in package.json.

Step 3: Configure Environment Variables

Create a .env file in the root of your project. You can copy the example file:

cp .env.example .env

Add your PostgreSQL database URL (from Neon or local PostgreSQL):

DATABASE_URL="postgresql://username:password@localhost:5432/neosaas"

Step 4: Set Up Prisma Database

NeoSaaS uses Prisma as the ORM. Follow these steps to set up your database:

4.1. Generate Prisma Client

Generate the Prisma Client based on your schema:

npx prisma generate

4.2. Run Database Migrations

Push the database schema to your database (creates tables):

npx prisma db push

Or run migrations for production:

npx prisma migrate deploy

4.3. (Optional) Seed the Database

If you want to populate your database with sample data:

npx prisma db seed

4.4. Open Prisma Studio (Optional)

Prisma Studio provides a visual interface to view and edit your database:

npx prisma studio

This will open Prisma Studio at http://localhost:5555

Step 5: Start the Development Server

Once everything is configured, start the Next.js development server:

npm run dev

Your application will be available at http://localhost:3000

Access the admin dashboard at http://localhost:3000/dashboard