Skip to main content

Developer Index

Last reviewed: 2026-04-21
Maintained by: Engineering

This is the canonical entrypoint for developer documentation in this repository.

Start Here​

Choose Your Path​

API only​

Prerequisites:

  • Node.js 20+
  • corepack enabled
  • Docker running

Commands:

corepack prepare pnpm@9.15.9 --activate
pnpm install
cp .env.example .env
docker compose up -d postgres
pnpm run db:migrate
pnpm run seed:demo
pnpm run dev:api

Expected URL:

  • API: http://localhost:3000

Next docs:

Web only​

Prerequisites:

  • Node.js 20+
  • corepack enabled
  • API running on http://localhost:3000

Commands:

corepack prepare pnpm@9.15.9 --activate
pnpm install
pnpm run dev:manager-desk
pnpm run dev:back-office

Expected URLs:

  • Manager Desk: http://localhost:3001
  • Back Office: http://localhost:3002

Next docs:

Mobile only​

Prerequisites:

  • Node.js 20+
  • corepack enabled
  • API running on http://localhost:3000
  • Expo tooling (device/simulator optional but recommended)

Commands:

corepack prepare pnpm@9.15.9 --activate
pnpm install
EXPO_PUBLIC_API_URL=http://127.0.0.1:3000/api pnpm run dev:zgrid-mobile

Expected result:

  • Expo DevTools/terminal starts and QR appears

Next docs:

Full stack local​

Prerequisites:

  • Node.js 20+
  • corepack enabled
  • Docker running

Commands:

corepack prepare pnpm@9.15.9 --activate
pnpm install
cp .env.example .env
docker compose up -d postgres
pnpm run db:migrate
pnpm run seed:demo

Run in separate terminals:

pnpm run dev:api
pnpm run dev:manager-desk
pnpm run dev:back-office
EXPO_PUBLIC_API_URL=http://127.0.0.1:3000/api pnpm run dev:zgrid-mobile

Expected URLs:

  • API: http://localhost:3000
  • Manager Desk: http://localhost:3001
  • Back Office: http://localhost:3002

Next docs:

App Runbooks​

Shared Workflows​

Operations + Platform​