Getting Started with ShipFast

Fresh

Source: shipfa.st/docs

AI Moves Fast!

Content freshness is indicated above. Always verify tool versions and APIs match current releases.

ShipFast is a NextJS boilerplate with everything you need to launch a startup fast. It supports both the App Router (/app) and Pages Router (/pages).

Start a Local Server

git clone https://github.com/Marc-Lou-Org/ship-fast.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
npm install
git remote remove origin
npm run dev

WARNING

ShipFast requires Node 18.17 or greater. Check with node -v.

Rename Environment File

mv .env.example .env.local

Open http://localhost:3000 to see your site.

NextJS Project Structure

Folder	Purpose
/app	Pages (1 folder + page.js = 1 page)
/app/api	API endpoints (1 file = 1 endpoint)
/components	React components
/libs	Library helpers (Stripe, Resend, auth, etc.)
/models	Database models

config.js File

This is the backbone of your app. Every key is documented. Configure:

• appName, appDescription, domainName (SEO defaults)
• stripe.plans (payment plans with priceId)
• auth.callbackUrl (redirect after login)
• colors.theme and colors.main (theming)
• crisp.id (customer support chat)
• resend.fromNoReply and resend.supportEmail

.env.local File

NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=           # Random 15+ character string
GOOGLE_ID=                 # Google OAuth client ID
GOOGLE_SECRET=             # Google OAuth secret
MONGODB_URI=               # MongoDB connection string
RESEND_API_KEY=            # Resend email API key
STRIPE_PUBLIC_KEY=         # Stripe public key
STRIPE_SECRET_KEY=         # Stripe secret key
STRIPE_WEBHOOK_SECRET=     # Stripe webhook signing secret

Next Steps

Follow the Ship in 5 Minutes tutorial to get your startup live.