oc-webui/README.md

39 lines
994 B
Markdown
Raw Normal View History

2024-03-17 17:35:26 +00:00
# BTClock WebUI
[![BTClock CI](https://github.com/btclock/oc-webui/actions/workflows/workflow.yml/badge.svg)](https://github.com/btclock/oc-webui/actions/workflows/workflow.yml)
The web user-interface for the OrangeBTClock, based on Svelte-kit and BTClock WebUI. It uses Bootstrap for the lay-out.
## Developing
After installed dependencies with `yarn`, start a development server:
```bash
yarn dev
# or start the server and open the app in a new browser tab
yarn dev -- --open
```
## Building
To create a production version of the WebUI:
```bash
yarn build
```
Make sure the postinstall script is ran, because otherwise the filenames are to long for the LittleFS filesystem.
## Deploying
To upload the firmware to the OC, you need to GZIP all the files. You can use the python script `gzip_build.py` for that.
Then you can make a `LittleFS.bin` with mklittlefs:
```bash
mklittlefs -c build_gz -s 409600 littlefs.bin
```
You can preview the production build with `yarn preview`.