Mirrors/blakeblackshear.frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2024-11-21 19:07:46 +01:00
Code Issues Projects Releases Wiki Activity

update frontend docs

Browse Source
This commit is contained in:
Blake Blackshear 2022-03-09 22:38:14 -06:00
parent 9bbe75d64e
commit 00112eb7bc
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/contributing.md
View File

@ -131,20 +131,16 @@ cd web && npm install
#### 3. Run the development server #### 3. Run the development server
```console ```console
cd web && npm run start cd web && npm run dev
``` ```
#### 3a. Run the development server against a non-local instance #### 3a. Run the development server against a non-local instance
To run the development server against a non-local instance, you will need to provide an environment variable, `SNOWPACK_PUBLIC_API_HOST` that tells the web application how to connect to the Frigate API: To run the development server against a non-local instance, you will need to modify the API_HOST default return in `web/src/env.js`.
```console
cd web && SNOWPACK_PUBLIC_API_HOST=http://<ip-address-to-your-frigate-instance>:5000 npm run start
```
#### 4. Making changes #### 4. Making changes
The Web UI is built using [Snowpack](https://www.snowpack.dev/), [Preact](https://preactjs.com), and [Tailwind CSS](https://tailwindcss.com). The Web UI is built using [Vite](https://vitejs.dev/), [Preact](https://preactjs.com), and [Tailwind CSS](https://tailwindcss.com).
Light guidelines and advice: Light guidelines and advice: