btclock-webui/README.md
2023-11-19 20:27:22 +01:00

1.0 KiB

BTClock WebUI

BTClock CI

The web user-interface for the BTClock, based on Svelte-kit. It uses Bootstrap for the lay-out.

Screenshot Screenshot Dark

Developing

After installed dependencies with yarn, start a development server:

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:

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 BTClock, 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:

mklittlefs -c build_gz -s 409600 littlefs.bin

You can preview the production build with yarn preview.