valenti/vocero-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(dev): explain the combined Vite and FastAPI launcher

Browse Source
This commit is contained in:
alvaro
2026-10-06 16:53:40 -03:00
parent c8f8aff8c7
commit 99413fc06d
6 changed files with 170 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files
s2s-client/README.md
+9 -4
View File
@@ -10,19 +10,24 @@ short_description: Voice chat over WebSocket against a HF speech-to-speech
hf_oauth: true
---
# Realtime voice client
# Realtime voice backend and retained static client
Browser voice-chat UI and FastAPI server for an OpenAI Realtime-compatible
FastAPI server and retained static voice-chat UI for an OpenAI Realtime-compatible
speech-to-speech backend. The browser streams microphone audio over WebSocket,
plays assistant audio, displays transcripts, and offers Spanish controls.
The root `start_ui.sh` now serves the [React frontend](../frontend-s2s) with
Vite on public port `8420`, proxying backend requests here on loopback port
`8421`. This directory's static UI remains available when FastAPI is run
directly or through the existing Docker image.
The complete [usage guide](../docs/client/usage.md) covers local startup,
connection modes, Docker, settings, and usage limits. See the
[documentation index](../docs/README.md), [architecture](../docs/client/architecture.md),
and [change history](CHANGELOG.md) for implementation details and history.
Assistant replies render Markdown with Marked and DOMPurify. Their pinned,
checked-in browser modules are served from `vendor/`, including upstream
The retained static client's assistant replies render Markdown with Marked and
DOMPurify. Their pinned, checked-in browser modules are served from `vendor/`, including upstream
licenses, so the UI does not require a CDN or a Node.js runtime. To refresh the
browser dependencies with Node.js 20 or newer after updating `package.json`: