Docs
v1 • Updated regularly
Back

Getting Started

Set up the project, environments, and first deploy in under 30 minutes.

What you'll achieve

  • Provision environments: development, staging, production.
  • Configure environment variables and secrets management.
  • Deploy the first build via CI with automated checks.

Prerequisites

  • Node 18+, Git, a cloud account (e.g., Vercel/Netlify/AWS).
  • Access to a managed database (e.g., Postgres).
  • Organization SSO (if required) and access to secrets vault.

Steps

  1. Fork the repository and create branches per feature.
  2. Run local dev: pnpm i && pnpm dev (or npm/yarn).
  3. Create a .env with API keys and DB connection strings.
  4. Push to the main branch to trigger CI build & preview deploy.

Validation

  • Health endpoint responds 200.
  • Smoke tests green on CI.
  • Staging URL is accessible and gated by basic auth.