jan/rusty-telemetry
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add Web Client section to README

Browse source
This commit is contained in:
Jan-Peter von Hunnius 2026-06-05 16:12:34 +02:00
parent dc10627842
commit 090ab7e559
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -255,6 +255,19 @@ All fields are optional.
}
```
## Web Client
A companion web application ([Racecraft](https://codeberg.org/jhunnius/racecraft)) provides a browser-based interface for live telemetry, session management, and data analysis visualization. It connects to the REST API and renders shift point charts, track maps, and real-time gauges.
To use with the web client, start the API on all interfaces:
```bash
RUSTY_TELEMETRY_API_HOST=0.0.0.0 cargo run --release
```
Then start the web client on the same machine — it proxies `/api/*` to `localhost:8080` automatically. Access from any machine on the LAN via the Vite dev server's network URL.
## Testing
```bash