mirror of
https://github.com/Dvorinka/Primora.git
synced 2026-10-28 15:51:23 +00:00
Tomas DvorakandDevin
420502eec1
- primora CLI + @primora/mcp server over generated client - auth users admin panel, mobile bottom nav - release workflow: GHCR images, compiled binaries, npm tarballs - fix gzip Content-Length truncation, nginx upstream re-resolution Authored By: TDvorak <[email protected]> Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
114 lines
4.7 KiB
Markdown
114 lines
4.7 KiB
Markdown
# 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`/`member` org roles, `admin`/`developer`/`viewer` project 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=true` or `VITE_DEMO_MODE=true`) for trying the UI without a backend.
|
|
|
|
## Quick start (Docker)
|
|
|
|
Prerequisites: Docker with the Compose plugin.
|
|
|
|
```bash
|
|
./scripts/setup.sh # creates .env, generates secrets, starts the stack
|
|
```
|
|
|
|
or manually:
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
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`:
|
|
|
|
```env
|
|
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
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
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](QUICK_START.md) — setup, configuration, troubleshooting
|
|
- [project_backend.md](project_backend.md) / [project_frontend.md](project_frontend.md) — original design specs
|
|
- [CONTRIBUTING.md](CONTRIBUTING.md) — development workflow
|
|
- `apps/backend/openapi/openapi.yaml` — API contract
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|