Skip to main content

​
Quickstart Guide

Follow the canonical local development setup in the root README. It owns the installation, environment, database, build, and startup commands.

​
Prerequisites

  • Node.js 22.22.1 (.nvmrc; package.json requires ^22.22.1)
  • pnpm 12.3.4 (package.json’s packageManager)
  • PostgreSQL or a local Supabase instance
  • Docker for Redis
  • Temporal CLI for a local Temporal server
  • Auth0 and Supabase credentials for the services you use
CI’s .github/actions/setup-node-pnpm/action.yml reads the pnpm pin from package.json and defaults to Node.js 22.

​
Setup

Use the README steps in order:
  1. Install dependencies.
  2. Configure environment variables. The templates are apps/webapp/.env.example, apps/temporal-workers/.env.example, and packages/database/.env.example; there is no root template. See the Environment Setup Guide for variable descriptions.
  3. Prepare the database. Use the root pnpm db:push script so Prisma runs in the database workspace with its configuration.
  4. Build workspace packages and seed.
  5. Start supporting services, then start CONA.
Visit http://localhost:3000 to access the application.

​
Documentation Development

Start the documentation server:
Visit http://localhost:4001 to preview the documentation. For more details about working with our documentation, see the docs guide.

​
Development Best Practices

  1. Package Management
    • Always use PNPM for package management
    • Run scripts using pnpm run or pnpm test
  2. Code Style
    • Write functional TypeScript code
    • Follow established project structure
    • Use descriptive variable names