Skip to main content

Local Setup

Prerequisites​

  • Bun
  • gcloud, logged in with your Birdy Grey account
  • A Fulfil API key for .env. Ask the team.

Install​

One package comes from Birdy Grey's private npm registry, so authenticate once before installing:

gcloud auth application-default login
npx google-artifactregistry-auth
bun install

Run​

Copy the values you need into .env (variables are listed in .env.schema), then:

bun run dev   # http://localhost:8080/tally

Routes keep the /tally prefix locally, matching the deployed paths. There's no API key locally.

Open http://localhost:8080/tally/public/docs to browse and send requests, or use the Bruno collection in bruno/.

Fulfil is production​

There's no Fulfil sandbox key, so local runs read production Fulfil, as staging does. Tally only reads from Fulfil, but every call counts against the shared rate limit.

Optional services​

ServiceWithout itTo enable locally
Slack alertsAlert endpoints return not_configured and post nothingSet BIRDY_BOT_HOST, BIRDY_BOT_API_KEY and ALERT_CHANNEL_ID

Checks​

bun run test:ci
bun run typecheck
bun run biome:check