Installation
Prerequisites
Before you begin, make sure you have:
- ā¢Node.js 18.17+ - download here
- ā¢PostgreSQL - locally or via Neon / Supabase (recommended)
- ā¢A license key - get one at indiegoon.dev
Create Your Project
Run the scaffolding CLI:
npx create-goon-app my-saas
You'll be prompted to:
- ā¢Enter your license key (from your purchase confirmation email)
- ā¢Choose a database provider - Neon (recommended), Supabase, PlanetScale, or SQLite
- ā¢Select optional modules - Blog, AI routes, Admin dashboard, Waitlist
The CLI will create your project, install dependencies, and set up the initial configuration.
Non-Interactive Mode
For CI/CD or AI agents, skip the prompts:
npx create-goon-app my-saas \
--key YOUR_LICENSE_KEY \
--db neon \
--features blog,admin \
--yes
The goon CLI
The goon CLI is built into every scaffolded project. There is no separate package to install globally. After npm install, the CLI is available as a local binary:
npx goon setup payments
You can also run goon directly since it is registered in your project's package.json bin field.
Verify Installation
Navigate to your project and start the dev server:
cd my-saas
npm run dev
Open http://localhost:3000. You should see the marketing landing page.
What Just Happened?
The scaffolder created a complete Next.js project with:
my-saas/
āāā src/
ā āāā app/ # Pages and API routes
ā āāā components/ # UI + marketing components
ā āāā config/ # App configuration
ā āāā lib/ # Auth, DB, payments, email
āāā content/ # Blog MDX files
āāā drizzle/ # Database migrations
āāā tests/ # E2E tests
āāā .env # Environment variables
āāā .goon/ # CLI manifest and rules
āāā package.json
Next Steps
- ā¢Quick Start - Configure your services and get everything running
- ā¢Project Structure - Understand the architecture in detail