patrick/OpenDTU-old
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

webapp documentation moved as well

Browse Source
This commit is contained in:
Bernhard Kirchen 2024-09-20 15:39:47 +02:00
parent 27f5a943f6
commit 4f5648689f
1 changed files with 2 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
webapp/README.md
View File

@ -1,27 +1,3 @@
# OpenDTU web frontend
# Moved
You can run the webapp locally with `yarn dev`. If you enter the IP of your ESP in the `vite.user.ts` beforehand (template can be found in `vite.config.ts`), all api requests will even be proxied to the real ESP. Then you can develop the webapp as if it were running directly on the ESP. The `yarn dev` also supports hot reload, i.e. as soon as you save a vue file, it is automatically reloaded in the browser.
## Project Setup
```sh
yarn install
```
### Compile and Hot-Reload for Development
```sh
yarn dev
```
### Type-Check, Compile and Minify for Production
```sh
yarn build
```
### Lint with [ESLint](https://eslint.org/)
```sh
yarn lint
```
Have a look at the [OpenDTU-OnBattery documentation](https://opendtu-onbattery.net/firmware/compile_webapp/).