diff --git a/web/.vscode/extensions.json b/web/.vscode/extensions.json new file mode 100644 index 000000000..7dea559d5 --- /dev/null +++ b/web/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "dbaeumer.vscode-eslint" + ] + } \ No newline at end of file diff --git a/web/README.md b/web/README.md index 6c994f77d..a2d84fbad 100644 --- a/web/README.md +++ b/web/README.md @@ -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= 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