ShipProject

Starter Kit — Setup Guide

From installation to live deployment — all in one page

Prerequisites

  • Node.js version 18 or higher (Node 20 or 22 recommended)
  • npm, pnpm, or yarn
  • Git
  • Terminal or VS Code

Quick Start — npx ship-create

The easiest way — type this command and answer 3 questions. Done in 30 seconds.

1

Run this command

terminal
npx ship-create

The system will ask for your project name, the type you want, and your package manager.

2

Choose what to build

? What do you want to build? (use arrow keys)

❯ SaaS App

CRM

Membership & Course

Lead Gen Funnel

... (8 types)

The system creates your project structure based on your selection — ready to use immediately.

3

Install packages

cd my-project
npm install
# or
pnpm install
4

Start the dev server

npm run dev

Open your browser at http://localhost:3000

Download Full OS

If you want everything in one place — 13 modules + starter kit + 50+ prompts, download it all.

terminal
git clone https://github.com/nireadaddy/the-ship-method-os.git
cd the-ship-method-os

# go to starter kit
cd starter-kit

npm install
npm run dev

What else is in the OS besides the starter kit?

  • 01-STRUCTURE/— business goals, scope, and feature priority
  • 07-PROMPTS/— 50+ ready-to-use AI prompts
  • 08-EXAMPLES/— real project examples from start to finish
  • 10-LAUNCH/— pre-launch checklist + domain + analytics
  • — and 9 more modules

Project Structure

After creating a project with npx ship-create
my-project/
├── src/
│   ├── app/
│   │   ├── page.tsx          # main page
│   │   ├── layout.tsx        # root layout
│   │   ├── globals.css       # theme & colors
│   │   ├── sale/             # sales page
│   │   ├── member/           # member area
│   │   │   ├── dashboard/
│   │   │   ├── content/
│   │   │   ├── billing/
│   │   │   └── settings/
│   │   ├── backoffice/       # admin panel
│   │   └── api/              # API routes
│   ├── components/           # shared components
│   └── lib/                  # helpers & copy
├── public/                   # images & media
├── package.json
└── .env.local                # secret config

Common Commands

npm run devStart dev server at localhost:3000
npm run buildBuild for production
npm run startStart production server (build first)
npm run lintCheck code quality
npx ship-createScaffold a new project from template

Built-in Demo Pages

The starter kit includes 16+ demo pages with mock data, ready to use immediately.

Blueprint Selector
/
Sales Page
/sale
Member Area
/member/dashboard
Admin Panel
/backoffice
CRM
/demo/crm
E-Commerce
/demo/ecommerce
SaaS App
/demo/saas
Marketplace
/demo/marketplace
Course & Membership
/demo/membership
Analytics Dashboard
/demo/dashboard
Directory
/demo/directory
Internal Tool
/demo/internal-tool
Lead Gen
/demo/leadgen
Booking
/demo/booking
Blog & Articles
/demo/blog
AI Chatbot
/demo/ai-chat
Social Feed
/demo/social-feed

Environment Setup

Create a .env.local file at your project root.

.env.local
# required
NEXT_PUBLIC_SITE_URL=http://localhost:3000

# email (Resend)
RESEND_API_KEY=re_xxxxxxxxxxxx
RESEND_AUDIENCE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
RESEND_FROM_EMAIL=hello@yourdomain.com
RESEND_FROM_NAME=Your Name

# payments (Stripe)
NEXT_PUBLIC_STRIPE_KEY=pk_test_xxxxxxxxxxxx
STRIPE_SECRET_KEY=sk_test_xxxxxxxxxxxx
STRIPE_WEBHOOK_SECRET=whsec_xxxxxxxxxxxx

# database (Neon / Postgres)
DATABASE_URL=postgresql://user:pass@host/db?sslmode=require

# auth
JWT_SECRET=your-secret-key-here

Using Vercel?

Set variables in Vercel Dashboard → Settings → Environment Variables, or run vercel env pull .env.local to pull them locally.

Deploy to Vercel

Deploy to Vercel with no extra configuration needed.

1

Push to GitHub

git init
git add .
git commit -m "initial commit"
git remote add origin https://github.com/your-username/your-project.git
git push -u origin main
2

Connect to Vercel

Go to vercel.com/new → Import Git Repository → select repo → click Deploy

Vercel auto-detects Next.js — no extra config needed.
3

Add Environment Variables

Go to Vercel Dashboard → Settings → Environment Variables and add the same values as your .env.local

4

Update your site

vercel --prod

Or push new code to GitHub — Vercel deploys automatically.

Want to walk through 30 days together?

The OS is free — if you want a study group, real feedback, and a guided path, join the course.