Skip to Content
runelay

Development

Work on runelay itself.

bun install
cp .env.example .env
bun run seed
bun run dev

For development, set PUBLIC_URL=http://localhost:5173 in .env. bun run seed creates a demo user, organization, connections and an API key. bun run dev starts the API on :4312 and the panel on :5173 (Vite proxies /v1).

Layout

apps/
  api/      Hono + better-auth + SQLite. Feature modules in src/modules/<feature>/{routes,services,repositories,...}
  web/      React + Vite + TanStack Router/Query + Tailwind + motion
  cli/      the runelay CLI
  docs/     this site (Fumadocs on TanStack Start)
packages/
  shared/   zod schemas, types and the { data, error } Result used by every app

Scripts

Script
bun run devAPI and panel with hot reload
bun run buildBuilds the panel (served by the API in production)
bun run build:cliCompiles the CLI into dist/cli/
bun run typechecktsc in every package
bun run checkBiome format and lint
bun run seedDemo data for local development
bun --filter @runelay/docs buildBuilds this docs site

On this page