BomLoomDevelopment setup
Run BomLoom locally.
Prerequisites
- Node.js 24 or later
- pnpm (version pinned in
package.json, enable it withcorepack enable) - Docker (for PostgreSQL)
First start
pnpm install
cp apps/backend/.env.example apps/backend/.env
pnpm devpnpm dev starts PostgreSQL via docker/compose.yaml, builds the API package and runs backend and frontend in watch
mode:
| Service | URL |
|---|---|
| Frontend | http://localhost:5173 |
| Backend | http://localhost:3000/api |
The documentation runs separately with pnpm --filter @bomloom/docs dev on http://localhost:3001.
Common tasks
| Command | Purpose |
|---|---|
pnpm lint | Lint everything with oxlint (type-aware). |
pnpm format | Format everything with oxfmt. |
pnpm typecheck | Type-check all packages. |
pnpm test | Run the tests. |
pnpm api:generate | Regenerate types and Zod schemas after editing openapi.yaml. |
pnpm db:generate | Create a migration after editing the Drizzle schema. |