Ops

Unified production observability for Coding Club IIT Guwahati.

Getting Started

Use Node.js 24.19.0 and pnpm 11.24.0.

On NixOS, enter the repository development shell first:

nix-shell

pnpm install
cp .env.example .env.local
docker compose -f docker-compose.dev.yml up -d
pnpm seed
pnpm dev

The web application runs at http://localhost:3005. Replace all placeholder configuration in .env.local before using authentication or ingestion. To enable Discord alerts, create a webhook for the intended server channel and set DISCORD_ALERT_WEBHOOK_URL in .env.local. The webhook is never exposed to the browser; administrators can verify it from the Alerts page.

Verification

pnpm typecheck
pnpm test
pnpm lint
pnpm build
pnpm contract:check
pnpm logger:check

The repository also publishes the frozen @coding-club-iitg/ops-contract and the independently versioned @coding-club-iitg/ops-logger - see each package's README for its release and integration contract.

Contributing

Before contributing, read:

• Contributing guidelines
• Project context