Skip to main content

Local Setup

Prerequisites​

  • Bun
  • gcloud, logged in with your Birdy Grey account
  • Staging Shopify app credentials 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

Locally there's no gateway, so there's no API key and no /cartographer prefix. Shopify credentials are needed for anything except /healthcheck.

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

Checks​

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