Add Continous Integration Build of Firmware Artifacts & Fix Build Script

.github/workflows/firmware.yaml

@@ -0,0 +1,34 @@
+# Basic continuous integration for firmware
+#    Copyright 2024 Lea Calot
+#
+# @author Lea Calot
+name: BuildFirmware
+on:
+  push:
+    branches: [ ]
+    tags:
+      - 'v*'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Install Python requirements
+        run: |
+          pip install -r requirements.txt
+      - name: Perform firmware build
+        run: |
+          pio run
+      - name: Upload firmware artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: FirmwareBinary
+          path: ./.pio/build/*
+          if-no-files-found: error

README.md

@@ -1,4 +1,5 @@
 # ESP32 SvelteKit - Create Amazing IoT Projects
+![Firmware Build](../../actions/workflows/firmware.yaml/badge.svg)
 
 <div style="flex">
 <img src="/docs/media/Screenshot_light.png" style="height:320px"> 

docs/buildprocess.md

@@ -2,6 +2,20 @@
 
 The build process is controlled by [platformio.ini](https://github.com/theelims/ESP32-sveltekit/platformio.ini) and automates the build of the front end website with Vite as well as the binary compilation for the ESP32 firmware. Whenever PlatformIO is building a new binary it will call the python script [build_interface.py](https://github.com/theelims/ESP32-sveltekit/scripts/build_interface.py) to action. It will check the frontend files for changes. If necessary it will start the Vite build and gzip the resulting files either to the `data/` directory or embed them into a header file. In case the WWW files go into a LITTLEFS partition a file system image for the flash is created for the default build environment and upload to the ESP32.
 
+All required Python packages are listed under [requirements.txt](../requirements.txt). To install platformio and these packages in a python virtual environment, use:
+
+```bash
+# Linux
+python -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+
+# Windows
+python -m venv venv
+call venv\Scripts\activate.bat
+pip install -r requirements.txt
+```
+
 ## Changing the JS package manager
 
 This project uses NPM as the default package manager. However, many users might have different preferences and like to use YARN or PNPM instead. Just switch the interface to one of the other package managers. The build script identify the package manager by the presence of its lock-file and start the vite build process accordingly.