Local Development

Run the project on your computer to customize it before deploying. This step is optional — you can deploy directly to Vercel without running locally.

Just want to deploy? Skip this page and go straight to the Setup Guide.

Step 1. Install Node.js

Download and install Node.js (version 18 or newer) from nodejs.org. Choose the LTS version. Follow the installer — no special settings needed.

Or install via terminal:

# macOS (Homebrew)
brew install node

# Windows / Linux (nvm)
nvm install --lts

Verify it's installed:

node -v

Step 2. Download the Project

After purchase, you'll receive access to the GitHub repository. Open your terminal and run:

git clone https://github.com/your-username/shipcommerce.git
cd shipcommerce

Don't have Git? Download it from git-scm.com. On Mac, it's pre-installed.

Step 3. Install Dependencies

In your terminal, make sure you're in the project folder, then run:

npm install

This downloads all the libraries the project needs. It takes about 1–2 minutes.

Step 4. Set Up Environment Variables

Copy the example configuration file:

cp .env.example .env.local

Open .env.local in any text editor and fill in your Supabase, Stripe, and Resend keys. See the Configuration page for details on each variable.

Important: Never share or upload the .env.local file. It contains your secret keys.

Step 5. Start the Project

npm run dev

Open http://localhost:3000 in your browser. You should see your store.

Useful Commands

CommandWhat it does
npm run devStart the project locally
npm run buildBuild for production (checks for errors)
npm run lintCheck code quality