Getting Started - ShipFast Docs

Show Prerequisites

Node.js 18.17+ (run node -v to check)
Code editor (VSCode, Cursor, etc.)
Terminal

Old Node version? Update it first.

Setup in 5 Steps

Clone and Install

Clone the repo and install dependencies:

Terminal

# Clone the repo
git clone git@github.com:mahdijafaridev/shipfast-so.git [YOUR_APP_NAME]
    
# Navigate to project
cd [YOUR_APP_NAME]
    
# Install dependencies
npm i
    
# Remove git origin
git remote remove origin

Create Environment File

Copy the example file:

Terminal

cp .env.example .env.local

You’ll fill in .env.local in the next steps.

Create Supabase Project

Set up your database:

Go to supabase.com/dashboard
Click “New project”
Fill in:
- Name: your-app-name
- Password: strong password (save it!)
- Region: closest to you
Click “Create new project”

Takes 1-3 minutes to spin up.

Get Your API Keys

Once your project is ready:

Go to Settings → API Keys
Create and copy these three values into .env.local:
Publishable key (NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY)
Secret key (SUPABASE_SECRET_KEY)
Project ID (NEXT_PUBLIC_SUPABASE_URL): Project Settings > General settings > Project ID

Never commit .env.local or share the secret role key.

Your .env.local should look like this:

.env.local

NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY=sb_publishable_...
SUPABASE_SECRET_KEY=sb_secret_...
NEXT_PUBLIC_SUPABASE_URL=https://asdfawefasdflajfewjf.supabase.co

Leave other variables empty for now. You’ll fill them during auth, payments, and email setup.

Start Development Server

Fire it up:

Terminal

npm run dev

Open localhost:3000 🎉

​Setup in 5 Steps

Setup in 5 Steps