Repository navigation
Local development
Terminal 1: API (Redis required; API must be enabled):
ORDRYN_MODE=full go run .Terminal 2: Vite (proxies /api → :8080):
npm run dev:webFrom web/: npm ci && npm run dev. Production build: npm run build:web (output web/dist/). Details: web/README.md.
No .env file is required for tests; a test session key is used automatically under go test.
go test ./... # Go (domain tests start an embedded PostgreSQL)
npm test # Vue unit tests (node:test)
make test # bothnpm run build:web also type-checks the SPA (vue-tsc) before the Vite build.
OpenAPI coverage (every registered /api/v2 route must appear in openapi.yaml):
go test ./internal/server/ -run 'TestOpenAPI|TestServerAPIV1' -count=1CI runs Go tests and builds the SPA on pushes and PRs (.github/workflows/go-test.yml, build-assets.yml). release_web_dist.yml attaches the web-dist zip to releases.
Clone Ordryn-Extensions and copy (or symlink) the folders you need into data/extensions/, which is gitignored. Edit a manifest, then click Reload Extensions in Admin; no restart needed. Test copies used by go test live in internal/extensions/testdata/extensions. Keep them in sync with the extensions repo when you change events or templates.
make run and make build stamp version.Version from git describe --tags --abbrev=0. Plain go run . / go build without -ldflags do not. Production binaries copied out of the git tree: Building-the-server.
The git tag is the version; nothing in source is bumped.
- Merge the intended changes to
main. - Publish a GitHub Release named
vX.Y.Ztargetingmain(creates the tag). That is enough; CI stamps server binaries and attachesweb-dist. - Hosts that
git pullthen rebuild must fetch tags and stamp-ldflagsif the binary is stored outside the checkout. See Building-the-server.
Do not move or reuse published version tags. Bump openapi.yaml info.version only for large or breaking API contract changes.
Getting started
- Home
- Self-hosting
- Building-the-server
- Configuration
- Admin-settings
- Reverse-proxy
- Extensions
- Upgrading
Using the API
Help