Getting Started

Prerequisites

• Node.js 18+
• Redis (local or Docker)
• PostgreSQL-compatible database (Neon or local Postgres)
• Valid environment variables for apps/api and apps/web

Install Workspace Dependencies

npm install

Start Services

Use separate terminals:

# Terminal 1
npm run dev:api

# Terminal 2
npm run dev:worker

# Terminal 3
npm run dev:web

# Terminal 4 (this docs app)
cd apps/docs
npm run dev

Default local assumptions used by runtime checks:

• API: http://localhost:4000
• Docs: http://localhost:3000 or next available docs port
• Redis: 127.0.0.1:6379

Verify Health

curl http://localhost:4000/health

Expected response:

{
  "success": true,
  "message": "API is healthy"
}

Go to Local Runtime Checklist for a practical smoke test sequence.