README.md

Backend

Backend API to provide sensor data using WebSockets.

🛠 Setting up the Development environment

This project uses python virtual environments venv to enable lightweight independent package installations. So to start setting up this project. You will need to run one of the following commands:

Windows

.\.venv\Scripts\activate.bat

.\.venv\bin\Activate.ps1

Linux or Mac

source .venv/bin/activate

Next, you must install the necessary dependencies and python packages via pip. For easier installation, we created requirements.txt you can install it like this:

pip install -r requirements.txt

♻️ Testing

To execute all unit tests we implemented the pytest library. An automatic GitHub action is also in place. It executes on every push to the main branch or after the creation of a pull request. To run it locally on your device execute the command in the repositories root directory:

pytest