Development

Back to index

Main Processes

During local development you usually run:

• backend server
• frontend dev server
• optional remote worker
• optional docs server

Backend

From backend/:

go run ./cmd/server

Optional worker:

go run ./cmd/agent

Frontend

From frontend/:

npm install
npm run dev

Docs

From the repo root:

pip install -r docs/requirements.txt
mkdocs serve

Useful Backend Commands

Run tests:

go test ./...

Sync example content:

go run ./cmd/sync-examples

Seed the local registry:

go run ./cmd/seed-zot

CLI

Build or run the CLI from:

• backend/cmd/ctl

Example:

go run ./cmd/ctl -- version

Frontend Quality Checks

From frontend/:

npm run typecheck
npm run build

Docs Deployment

The repository now includes:

• .github/workflows/docs.yml

That workflow installs the docs dependencies and deploys the generated site.