Documentation

Environment Setup

Configure your workstation so StartupKit runs exactly the same way it does for your customers. No GitHub access is required—everything ships as a zipped folder you control.

Local Requirements

  • Node.js 18+ and npm 10+ (use nvm or Volta to match versions)
  • MongoDB Atlas account (or any MongoDB 6.x cluster)
  • Stripe account + Stripe CLI for webhook testing
  • Resend account (optional in dev because links are logged)

Bootstrap the Project

  1. Unzip startupkit.zip and move the folder somewhere permanent.
  2. Install packages: npm install.
  3. Copy the example env file: cp .env.example .env, then fill in the values from your providers.
  4. Generate the Prisma client: npx prisma generate.
  5. Push the schema to your database (safe for dev): npx prisma db push.

No Git history required

Because customers receive a fresh zip, they can import the folder into their own private repo or keep it offline. The documentation intentionally references only local commands.

Command Cheat Sheet

CommandWhen to run
npm run devStarts the Next.js dev server on http://localhost:3000.
npm run buildCreates a production build before deploying to Vercel or any Node host.
npm run startRuns the compiled app locally (uses .env values).
npm run lintEnsures the codebase passes the default ESLint config.

Development Helpers

  • /dev-tools: Verify email addresses without sending actual emails, perfect when Resend is not configured yet.
  • Terminal logs: Verification and password reset links are printed automatically whenever Resend credentials are missing.
  • Seed-free sample data: Register through the UI to create your first account; no seeding scripts are required.

Recommended Global Tools

  • MongoDB Compass or Atlas UI for browsing data and clearing sessions.
  • Stripe CLI for streaming webhook events to /api/stripe/webhook.
  • ngrok (optional) when you want to share the local app with teammates for review.