From 10c1f7ead4636bccf40356e34ba4ea1f380dacfb Mon Sep 17 00:00:00 2001 From: Sam Wright Date: Thu, 20 Jun 2024 00:11:51 +1000 Subject: [PATCH] Update web readme (#12062) * Update web readme * Update /web readme * Apply suggestions from code review Co-authored-by: Nicolas Mowen --------- Co-authored-by: Sam Wright Co-authored-by: Nicolas Mowen --- web/.vscode/extensions.json | 5 +++++ web/README.md | 43 ++++++++++++++++--------------------- 2 files changed, 24 insertions(+), 24 deletions(-) create mode 100644 web/.vscode/extensions.json 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 0d6babedd..b30fa7341 100644 --- a/web/README.md +++ b/web/README.md @@ -1,30 +1,25 @@ -# React + TypeScript + Vite +This is the Frigate frontend which connects to and provides a User Interface to the Python backend. -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +# Web Development -Currently, two official plugins are available: +## Installing Web Dependencies Via NPM -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +Within `/web`, run: -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: - -- Configure the top-level `parserOptions` property like this: - -```js -export default { - // other rules... - parserOptions: { - ecmaVersion: 'latest', - sourceType: 'module', - project: ['./tsconfig.json', './tsconfig.node.json'], - tsconfigRootDir: __dirname, - }, -} +```bash +npm install ``` -- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` -- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list +## Running development frontend + +Within `/web`, run: + +```bash +PROXY_HOST= npm run dev +``` + +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