Skip to main content

Local Setup

Prerequisites​

  • Bun
  • gcloud, logged in with your Birdy Grey account

Install​

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

bun run gcloud:auth
bun install

Run​

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

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

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

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

Gemini locally​

Try-on and palettes call Gemini in the GCP project named by GCP_PROJECT_ID, using your own Google login. Set it to api-platform-staging-1 so local runs bill to staging. Your account needs access to Vertex AI in that project.

Optional services​

ServiceWithout itTo enable locally
RedisTry-on returns 503; palettes aren't cachedSet REDIS_URL
catalog-apiPalette generation returns 502Set API_GATEWAY_BASE_URL to staging and API_GATEWAY_KEY
SentryErrors print to the consoleSet SENTRY_DSN

Checks​

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