Contributor guide

Strict from the first commit

The Bun-managed Angular 22 workspace validates renderer, desktop, shared, and documentation code together.

Browse the source Read the contributor guide

Install and run

Use Bun 1.3.14 and Node.js 24.18 or newer, but earlier than Node.js 25. The main start command compiles Electron code, serves the renderer on 127.0.0.1:4200, and opens the desktop window; start the docs separately when needed.

bun install --frozen-lockfile
bun run start
bun run start:docs

Workspace layout

projects/electron contains the standalone zoneless renderer, shared IPC contracts, Electron main and preload code, SQLite, Soccerbot integration, exports, and tests. projects/docs contains this statically generated site.

Quality gates

TypeScript strict mode, typed ESLint, Angular template accessibility checks, AXE tests, Prettier, Vitest, lint-staged, commit-message validation, and Husky are enforced through root scripts and CI.

bun run format:check
bun run lint
bun run typecheck
bun run test
bun run validate