alvaro
abd03ed07d
Rename the project directories, Python distribution and import package, and npm package. Update launcher, Docker, tooling, tests, lockfiles, and documentation while preserving existing API contracts. Make AGENTS.md self-contained and remove external skill and workflow references.
2.5 KiB
title, emoji, colorFrom, colorTo, sdk, app_port, pinned, short_description
| title | emoji | colorFrom | colorTo | sdk | app_port | pinned | short_description |
|---|---|---|---|---|---|---|---|
| HF Realtime Voice | 🎙️ | indigo | purple | docker | 7860 | false | Voice chat over WebSocket against a HF speech-to-speech |
Vocero API
FastAPI APIs and WebSocket relay for the React voice frontend. This service handles configuration, caller context, upstream authentication, search, reasoning, ApiPilot tools, and optional load-balancer allocation.
The root start_ui.sh now serves the React frontend with
Vite on public port 8420, proxying backend requests here on loopback port
8421. The browser UI lives entirely in vocero-frontend; running FastAPI directly
or through Docker exposes only backend routes and shared documentation.
The complete usage guide covers local startup, connection modes, Docker, settings, and queue behavior. See the documentation index, architecture, and change history for implementation details and history.
Build from the repository root so the container includes the documentation:
docker build -f vocero-api/Dockerfile -t vocero-api .
The Python project is contained in this directory: pyproject.toml, uv.lock,
.python-version, .venv, quality tools, and tests. Use uv 0.12.5 and Python
3.12 (uv can provision Python). From the repository root:
make -C vocero-api install
make -C vocero-api check
Tests isolate environment configuration, use HTTP fixtures for allocation and caller authentication, and start a loopback WebSocket service to verify audio frames, keepalive, and teardown. No deployed services or database are needed.
See backend development and compatibility for
formatting, typing, schema policy, optional Git hooks, and deployment checks.
uvicorn server:app --app-dir vocero-api remains a supported entry point;
the implementation lives in the vocero_api/ package. Its Python distribution
name is vocero-api.
FastAPI's API explorer remains at /docs. Project documents are served as files below
/docs/client/, /docs/speech/, /docs/adr/, /docs/examples/, and
/docs/proposals/. The historical /project/ and /public/docs.html URLs
redirect to the retained architecture proposal. Markdown remains source text;
documentation directories are not browsable rendered pages. Start from the
repository documentation index or request /docs/README.md explicitly.