Oximy Docs

Local setup

Repo-oriented setup notes for engineers working on Oximy.

Package manager

The monorepo uses pnpm@9.15.0 and Turbo. Apps and packages are declared in pnpm-workspace.yaml:

pnpm install

Common app commands

pnpm dev:local
pnpm dev:dashboard
pnpm --filter @oximy/api dev
pnpm --filter docs dev

The docs app runs on port 3102 by default.

Useful checks

pnpm --filter docs typecheck
pnpm --filter docs lint
pnpm --filter docs build

For dashboard changes, prefer the existing dashboard scripts:

pnpm --filter dashboard typecheck
pnpm --filter dashboard lint
pnpm --filter dashboard test

Workspace guidance

This repository is often worked through Conductor workspaces. Always verify the real repo root and current branch before staging or pushing changes.

On this page