Docs

Getting Started

The exact steps that ship in every edition’s own README — nothing held back for the sales page.

1. Install dependencies

pnpm install

2. Configure your environment

cp .env.example .env

Fill in your database URL, JWT secrets, and payment keys for whichever providers your edition includes.

3. Set up the database

cd packages/database
pnpm prisma migrate dev
pnpm prisma generate
pnpm seed

The seed step creates demo accounts across all three roles so you can log in and click around immediately.

4. Run the app

# Terminal 1
cd apps/api && pnpm dev   # API at http://localhost:12002

# Terminal 2
cd apps/web && pnpm dev   # Web at http://localhost:12003

API reference

A full Swagger/OpenAPI UI is generated automatically at http://localhost:12002/api/docs once the API is running — every endpoint, request/response shape, and auth requirement for your edition’s modules.