The web user-interface for the BTClock

Go to file

Djuri Baars 9867988a09 Dependency updates, add clarification for Nostr Datasource		2024-10-01 20:34:41 +02:00
.github	Bugfix and dependency updates	2024-09-11 02:26:10 +02:00
.vscode	Added WiFi signal status and settings	2023-11-21 16:05:00 +01:00
doc	Add license	2023-11-19 16:27:43 +01:00
extra/icons	Remove icons to save space in image	2024-09-03 12:37:35 +02:00
patches	Dependency updates	2024-09-25 00:53:52 +02:00
src	Dependency updates, add clarification for Nostr Datasource	2024-10-01 20:34:41 +02:00
static	Remove icons to save space in image	2024-09-03 12:37:35 +02:00
tests	Dependency upgrades	2024-09-03 12:11:14 +02:00
.gitignore	Write more tests	2023-11-25 00:42:37 +01:00
.npmrc	Initial commit	2023-11-17 01:05:35 +01:00
.prettierignore	Lint and format all files	2023-11-19 20:27:22 +01:00
.prettierrc	Initial commit	2023-11-17 01:05:35 +01:00
Dockerfile	Create GitHub workflow and Dockerfile	2023-11-19 15:08:26 +01:00
eslint.config.js	Dependency upgrades	2024-09-03 12:11:14 +02:00
gzip_build.py	Making it work for ESP32	2023-11-17 11:09:06 +01:00
package.json	Dependency updates, add clarification for Nostr Datasource	2024-10-01 20:34:41 +02:00
playwright.config.ts	Add mock api and test reporting	2023-11-23 02:35:09 +01:00
README.md	Lint and format all files	2023-11-19 20:27:22 +01:00
svelte.config.js	Use svelte preprocess, generate random colors, check GZipped filesize	2023-11-21 20:43:17 +01:00
tsconfig.json	Dependency upgrades	2024-09-03 12:11:14 +02:00
vite.config.ts	Dependency upgrades	2024-09-03 12:11:14 +02:00
yarn.lock	Dependency updates, add clarification for Nostr Datasource	2024-10-01 20:34:41 +02:00

README.md

BTClock WebUI

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

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.