diff --git a/AGENTS.md b/AGENTS.md index 9181129..c11548c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -5,7 +5,7 @@ - **H3 server** handlers in `/server` - **Shared types/utils** in `/shared` - MongoDB models in `/server/models` -- **Python backend** (`OpenSquawk-LiveATC-api`) — owns PM session state and routing decisions; runs on `http://127.0.0.1:8000` +- **Python backend** (`OpenSquawk-API`) — owns PM session state and routing decisions; runs on `http://127.0.0.1:8000` ## Key Files - `/shared/utils/communicationsEngine.ts` — Core state machine composable (used by `/pm` live ATC). Drives local cursor and TTS; Python backend owns the authoritative state. @@ -41,4 +41,4 @@ Transitions: `next`, `ok_next`, `bad_next`, `timer_next`, `auto_transitions`. ## Commands - `bun run dev` — dev server (Nuxt) -- Python backend: see `OpenSquawk-LiveATC-api/README.md` +- Python backend: see `OpenSquawk-API/README.md` diff --git a/CLAUDE.md b/CLAUDE.md index 91bc7f1..4221eba 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -4,7 +4,7 @@ This repository is the self-hostable OpenSquawk application. It contains the browser UI and its H3 API. It does not own the authoritative Live ATC decision -state; that belongs to the separate `OpenSquawk-LiveATC-api` service. +state; that belongs to the separate `OpenSquawk-API` service. ## Architecture @@ -35,7 +35,7 @@ with the configured `NUXT_PUBLIC_AUTH_ISSUER`; the app then owns its session. ## Live ATC Flow -1. The frontend loads a runtime flow from `OpenSquawk-LiveATC-api`. +1. The frontend loads a runtime flow from `OpenSquawk-API`. 2. It creates an authoritative radio session in the Python backend. 3. PTT audio is transcribed through `POST /api/atc/ptt`; text input skips STT. 4. The transmission is sent to the Python session. @@ -65,7 +65,7 @@ yarn test yarn typecheck ``` -Start `OpenSquawk-LiveATC-api` separately with: +Start `OpenSquawk-API` separately with: ```bash poetry run uvicorn main:app --reload diff --git a/README.md b/README.md index 399a744..1f857cb 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ and optional simulator/cockpit bridge integration. This repository contains the Nuxt application and its H3 API. Live ATC routing and authoritative session state are provided by the separate -[`OpenSquawk-LiveATC-api`](https://github.com/OpenSquawk/OpenSquawk-LiveATC-api) +[`OpenSquawk-API`](https://github.com/OpenSquawk/OpenSquawk-API) service. ## Requirements - Node.js 22 and Yarn 4 - MongoDB -- Python 3.12 and Poetry for `OpenSquawk-LiveATC-api` +- Python 3.12 and Poetry for `OpenSquawk-API` - An OpenAI-compatible service for cloud STT/TTS, or a configured local speech provider @@ -33,7 +33,7 @@ Generate strong values for `JWT_SECRET`, `APP_JWT_SECRET`, and `SERVICE_SECRET`. Keep `AUTH_MODE=open` for a self-hosted instance without a login. Configure the speech provider variables required by your setup. -In a separate checkout of `OpenSquawk-LiveATC-api`, start the decision backend: +In a separate checkout of `OpenSquawk-API`, start the decision backend: ```bash poetry install @@ -60,7 +60,7 @@ when `TELEMETRY_URL` is empty. ## Services -- `OpenSquawk-LiveATC-api`: decision flows, routing, and Live ATC session state +- `OpenSquawk-API`: decision flows, routing, and Live ATC session state - MongoDB: application identities, progress, reports, and logs - OpenAI-compatible or local speech service: transcription and controller audio - Optional bridge: simulator and cockpit integration