flyg-backend

The backend for the flyg platform: a virtual-aviation service where pilots rent aircraft, fly orders in X-Plane 12, and earn money for verified flights.

One process serves two contracts.

Surface	Path	Format	Client	Credential
Website	/api/v1	JSON, RFC 9457 errors, SSE	flyg-frontend	Session cookie plus a double-submit CSRF header
Simulator	/v1	Protobuf over HTTP and WebSocket	flyg-plugin-xplane12	Bearer device token

This repository invents neither contract. The website's belongs to flyg-frontend/openapi.yaml, and the simulator's to the flyg-proto schemas. This repository implements both and bridges them: a preflight set on the website reaches the sim, and telemetry from the sim reaches the browser.

The plugin is a sensor and an actuator. Every judgement — whether an order was delivered, whether a recording is trustworthy, what a flight earned — is made here, from what was persisted rather than from what the client asserted.

Running it

cp .env.example .env          # then set DATABASE_URL if you are not using compose
docker compose up -d db       # Postgres on 5433, to stay out of a local one's way
cargo run                     # migrates at startup, then serves

Point the website at it with VITE_API_PROXY=http://localhost:8080 in flyg-frontend.

The whole stack in containers:

docker compose up --build

Layout

Crate	Holds
flyg-core	Domain rules with no IO: payouts, verdicts, flight summaries, readiness, track thinning, chunk signatures, cursors
flyg-proto	Types generated from the proto/ submodule by prost
flyg-server	The binary: axum routers for both surfaces, sqlx repositories, and the hub that joins them

proto/ is the shared schema repository at ssh://git@git.janke.biz:2222/flyg/proto.git, which the plugin uses too. Clone with submodules, or run git submodule update --init --recursive afterwards. Either way needs an SSH key that git.janke.biz accepts.

The hub lives in memory, so it describes this process alone. A second instance would report only its own simulator connections. Running more than one requires a shared channel first.

Tests

cargo test --workspace

flyg-core is tested on its own. flyg-server starts a real server on an ephemeral port, gives each test its own database, and drives both surfaces over real HTTP and real WebSockets: a test signs chunks the way the plugin does, and the server verifies them the way it will in production.

DATABASE_URL must point at a Postgres that may create databases.

Documents

• docs/BACKEND_PLAN.md — the architecture, the milestones, and the policy questions still open.
• docs/openapi.yaml — the web contract, copied from flyg-frontend, served at /api/v1/openapi.yaml. scripts/check-contract.sh catches the two drifting apart.