Getting started
Run the Goalkeeper local development environment.
Prerequisites
- Bun 1.3 or newer
- Docker with Compose
Installation
bun install
cp .env.example .envDevelopment
Start PostgreSQL and the application services:
bun run devTo work on one component, use bun run web:dev, bun run api:dev,
bun run mcp:dev, or bun run docs:dev.
Open http://localhost:3000 to exercise the local authentication flow.
Register with an email and password from /sign-in. The API logs the local
verification message and link to its terminal. Open the link and confirm
verification. You can also verify a local principal directly:
bun run auth:verify-email -- user@example.comThe API applies its PostgreSQL migrations at startup. Run bun run db:migrate
to apply them without starting the API service.
Validation
bun run check