Skip to content

Local setup

  • Bun 1.3.11 or newer in the 1.3 line.
  • PostgreSQL 16 with PostGIS.
  • Valkey or Redis.
  • Meilisearch for location search.
  • S3-compatible storage and imgproxy only when working on image upload or production-like media flows.
Terminal window
bun install
bun --filter @repo/database db:generate

Copy the root env template only when you need to run apps against local services:

Terminal window
cp .env.example .env.local

Never paste secrets into docs or committed files. The source of truth for variable meaning is Settings → Environment variables.

SurfaceCommandNotes
Docsbun --filter @repo/docs devRuns generators first, then Astro/Starlight.
Webcd apps/svelte-web && bun run devMain SvelteKit app.
APIbun --filter api devHono host for Better Auth and tRPC.
Workerbun --filter worker devBullMQ jobs; use matching QUEUE_SUFFIX in dev.

For a docs-only onboarding loop, run bun --filter @repo/docs build first. It validates MDX, generated API pages, Knock workflow pages, design tokens, and the generated workspace inventory.

The native iOS and Android apps are product apps but not Bun workspaces. Use their Xcode/Gradle commands and the native CI workflows. They still depend on the shared API contract and synced i18n catalogs.