Self Hosting

Self-hosting is optional. If you only want to read and write data on the live product, create an API key and call guilders.app. See Using the API.

What you get

A self-hosted instance exposes the same REST API, OpenAPI spec, API keys, and webhooks. Clients should use your origin instead of https://guilders.app.

Local development

From the GitHub repo:

bun install
cp apps/api/.env.example apps/api/.env
bun run db:up
bun run db:migrate && bun run db:init

Then start the API (cd apps/api && bun run dev) at http://localhost:3000. Create a user, open Settings → Developer, and generate a key the same way as on the hosted dashboard.

curl http://localhost:3000/api/account \
  -H "x-api-key: $GUILDERS_API_KEY"

OpenAPI for a local API lives at http://localhost:3000/openapi.

Production

Deploy the API Worker and dashboard. Point API clients at your public origin instead of https://guilders.app. Keep API keys and webhook secrets out of source control.