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 (format:
GOON-XX-XXXXXXXX-XXXX) - ā¢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 GOON-PR-ABCDEFGH-1234 \
--db neon \
--features blog,admin \
--yes
Install the Project CLI
After scaffolding, install the goon CLI globally (optional but recommended):
npm install -g goon
Or use it via npx:
npx goon setup payments
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