Skip to content

Installation

Giancarlo Buomprisco edited this page Dec 21, 2024 · 1 revision

Getting Started

Prerequisites

  • Node.js 18.x or later (preferably the latest LTS version)
  • Docker
  • PNPM

Please make sure you have a Docker daemon running on your machine. This is required for the Supabase CLI to work.

Installation

1. Clone this repository

git clone https://github.com/makerkit/next-supabase-saas-kit-lite.git

2. Install dependencies

pnpm install

3. Start Supabase

Please make sure you have a Docker daemon running on your machine.

Then run the following command to start Supabase:

pnpm run supabase:start

Once the Supabase server is running, you can access the Supabase dashboard at http://localhost:54321.

You will also find all the Supabase services printed in the terminal after the command is executed.

Stopping Supabase

To stop the Supabase server, run the following command:

pnpm run supabase:web:stop
Resetting Supabase

To reset the Supabase server, run the following command:

pnpm run supabase:web:reset
More Supabase Commands

For more Supabase commands, see the Supabase CLI documentation.

# Create new migration
pnpm --filter web supabase migration new <name>

# Link to Supabase project
pnpm --filter web supabase db link

# Push migrations
pnpm --filter web supabase db push

4. Start the Next.js application

pnpm run dev

The application will be available at http://localhost:3000.

5. Code Health (linting, formatting, etc.)

To format your code, run the following command:

pnpm run format:fix

To lint your code, run the following command:

pnpm run lint

To validate your TypeScript code, run the following command:

pnpm run typecheck

Turborepo will cache the results of these commands, so you can run them as many times as you want without any performance impact.