01 · Getting started
Run the CLI, boot the app
Install prerequisites, scaffold a new project, configure .env, and get the dev server running in under five minutes.
Everything you need to run the CLI, understand the architecture, and extend Orbit with your own domain. Docs are maintained alongside the code — version-pinned to the release your CLI scaffolded.
Install prerequisites, scaffold a new project, configure .env, and get the dev server running in under five minutes.
The ideas that shape every bounded context: workspaces, teams, PBAC, the Unit of Work, the event bus, and the realtime hub.
Recipes for the things you'll actually do next: adding a new bounded context, a new permission, a new billing plan, a new email template.
Generated reference for the HTTP API, the Prisma schema, the shared DTO + permissions package, and the realtime event catalog.
How each provider port is shaped, and how to swap Stripe → Polar, Resend → your own SMTP, graphile-worker → QStash, etc.
Deploy targets we've verified, environment checklists, and the Postgres, secrets, and webhook routing you'll need.
The README covers a 90-second tour, env vars, and the Postgres bootstrap. Everything else you'll learn by following the code — each bounded context has the same shape.