vviz docs

Developer Docs

Local Setup

Install, run and check the monorepo locally.

Prerequisites

Use Node 20 or newer and pnpm 9.

corepack enable
corepack prepare pnpm@9 --activate
pnpm install

Environment

Copy the example environment into a root .env file:

make setup

The API uses port 4000. The main web app uses port 3000. The docs app uses port 3001.

Run the app locally

Start MongoDB and Redis:

pnpm dev:infra

Run the API, worker and web app:

pnpm dev

Open:

  • web app: http://localhost:3000
  • API health: http://localhost:4000/health
  • docs: pnpm dev:docs, then http://localhost:3001

Check your work

Use these before opening a pull request:

pnpm typecheck
pnpm docs:check

docs:check makes sure the generated API/model/contract reference is current and that every route has a JSDoc block for the docs.