Authored By: TDvorak <[email protected]>
Primora
A self-hosted backend platform for building products — auth, Postgres-backed APIs, object storage, JSON document collections, API keys, and a full audit log behind one dashboard. Inspired by the UX of Appwrite and Supabase, with no hosted tier: your data stays on your hardware.
Browser ──▶ Nginx ──▶ Frontend (SolidJS + Vite)
├──▶ Auth service (Better Auth + Hono)
└──▶ API (Go + Gin) ──▶ PostgreSQL
──▶ DragonflyDB (Redis-compatible cache)
──▶ Local filesystem object storage
What you get
- Organizations & projects — top-level workspaces containing projects, members, and scoped roles (
owner/admin/memberorg roles,admin/developer/viewerproject roles). - Auth — email/password plus optional GitHub, Google, Discord, and Microsoft OAuth via Better Auth. JWTs minted by the auth service are verified by the Go API against JWKS.
- Storage — S3-style buckets and objects backed by your local filesystem, with public/private visibility and downloadable URLs.
- Collections — schema-flexible JSON documents stored in Postgres JSONB.
- API keys —
pk_live_/pk_test_credentials with prefixes; secrets are shown once. - Audit log — every mutating request recorded with actor, resource, request ID, and timestamp; CSV/JSON export from the dashboard.
- Generated client — the TypeScript client is generated from
apps/backend/openapi/openapi.yaml, so the API contract is the source of truth. - Demo mode — a fully client-side workspace (
?demo=trueorVITE_DEMO_MODE=true) for trying the UI without a backend.
Quick start (Docker)
Prerequisites: Docker with the Compose plugin.
./scripts/setup.sh # creates .env, generates secrets, starts the stack
or manually:
cp .env.example .env # fill JWT_SECRET and BETTER_AUTH_SECRET
docker compose up -d --build
Then open http://localhost. Mailpit is at http://localhost/mailpit/ for local email.
If ports 5432 or 6379 are already in use on your machine, set POSTGRES_PORT and DRAGONFLY_PORT in .env — only the host bindings change.
Verification
| Check | Endpoint |
|---|---|
| Frontend | http://localhost/ |
| Backend liveness | http://localhost/api/v1/health/liveness |
| Backend readiness | http://localhost/api/v1/health/readiness |
| Auth health | http://localhost/auth-health |
| OpenAPI spec | http://localhost/api/v1/openapi.yaml |
Local development
docker compose up -d postgres dragonfly mailpit # infrastructure only
cd apps/backend && go run ./cmd/server # API on :8080
npm run dev:auth # auth on :3001
npm run dev:frontend # dashboard (Vite)
Point the frontend at the stack by adding to apps/frontend/.env.local:
VITE_API_BASE_URL=http://localhost/api/v1
VITE_AUTH_BASE_URL=http://localhost/auth
Or skip all of it: http://localhost:<vite-port>/?demo=true runs entirely in the browser.
CLI
npm run build --workspace @primora/cli # → apps/cli/dist/cli.js
node apps/cli/dist/cli.js login # or: npx primora login once published
Supports session sign-in (primora login) and API-key mode (primora login --api-key prm_… or PRIMORA_API_KEY). Context lives in ~/.config/primora/config.json; primora use picks org + project interactively. Commands: orgs, projects, buckets, objects (list/upload/download/rm), keys, audit list --follow. Every command accepts --json.
Quality gate
npm run check # backend tests + frontend typecheck + build + generated-code drift check
npm test # workspace tests
npm run generate:sqlc # regenerate sqlc after changing queries/schema
npm run generate:client # regenerate the TS client after changing openapi.yaml
Repository layout
apps/
backend/ Go + Gin API, sqlc, migrations, object storage
auth/ Better Auth on Hono (sessions, JWT, OAuth, mail)
frontend/ SolidJS + Tailwind dashboard
cli/ `primora` CLI — login, context, projects, buckets, objects, keys, audit
packages/
api-client/ OpenAPI-generated TypeScript client (do not hand-edit)
shared-types/
infra/nginx/ Reverse proxy config
scripts/ setup.sh, verify-production-ready.sh
Documentation
- QUICK_START.md — setup, configuration, troubleshooting
- project_backend.md / project_frontend.md — original design specs
- CONTRIBUTING.md — development workflow
apps/backend/openapi/openapi.yaml— API contract