Update /web readme

This commit is contained in:
Sam Wright 2024-06-19 23:11:43 +10:00
parent feae06561c
commit 6462f4a06b
2 changed files with 21 additions and 5 deletions

5
web/.vscode/extensions.json vendored Normal file
View File

@ -0,0 +1,5 @@
{
"recommendations": [
"dbaeumer.vscode-eslint"
]
}

View File

@ -1,10 +1,21 @@
# To run
This is the Frigate frontend which connects to and provides a User Interface to the Python backend.
# Installing
Within `/web`, run:
```bash
npm install
```
# Running
Within `/web`, run:
```bash
PROXY_HOST=<ip_address:port> npm run dev
```
# Tech stack
- React
- TypeScript
- Vite
The Proxy Host can point to your existing Frigate instance. Otherwise defaults to `localhost:5000` if running Frigate on the same machine.
# Extensions
Install these IDE extensions for an improved development experience:
- eslint