Skip to content
Download

Development

  • Node.js ≥ 22.12.0.
  • pnpm ≥ 11.15.1. The install script can enable it with corepack.
Terminal window
./scripts/install.sh
./scripts/start.sh

On Windows:

Terminal window
scripts\install.bat
scripts\start.bat

The frontend runs at http://localhost:4321 and proxies /api to the backend at http://localhost:3001.

Manual install:

Terminal window
corepack enable
corepack prepare pnpm@11.21.0 --activate
pnpm install
pnpm dev
Terminal window
pnpm check:arch # architecture rules
pnpm check # architecture + typecheck + lint
pnpm --filter @workspace/backend test
pnpm --filter @workspace/frontend exec vitest run

pnpm check:arch verifies the frontend size limit, backend hexagonal boundaries, frontend lib/ purity, shared package purity, generic hooks, dead files and feature isolation. Read AGENTS.md for the full rules.

Package Purpose
packages/backend Express + Drizzle + SQLite API. Hexagonal architecture.
packages/frontend Astro + React UI.
packages/shared Types and framework-agnostic helpers.
packages/ui Reusable shadcn/ui components.
packages/website This public site (Astro + Starlight).

Read CONTRIBUTING.md and open a pull request. master is protected; CI must pass before merging. Use conventional commits and keep changes small.