|
ℹ️
|
enV5 folder |
Provide the implementation for the Elastic Node hardware to be used.
|
ℹ️
|
cloud folder |
Provide the backend cloud side as the communication/service endpoint for the Hardware.
The required tools can be started with the provided docker compose file.
|
🔥
|
A running MQTT Broker is assumed! |
- GCC
-
→ C Compiler
Can be installed via your local package manager like dnf, apt or brew. - CMake
-
→ Build System
Can be installed via your local package manager like dnf, apt or brew. - Ninja [OPTIONAL]
-
→ Build Tool
Can be installed via your local package manager like dnf, apt or brew. - Python [OPTIONAL]
-
→ Python Interpreter
Can be installed via your local package manager like dnf, apt or brew.
Used for development Server and Pre-commit! - Node.js [OPTIONAL]
-
→ Javascript Runtime
Can be installed via your local package manager like dnf, apt or brew.
Used for Commitlint hook of Pre-Commit!
To ensure our commit guidelines, we recommend using Commitlint in combination with Pre-Commit. To assure you don’t corrupt your system we recommend installing the dependencies inside a virtual environment.
-
Install Node.js
-
Install Node.js packages from package.json with
npm ci -
Create and checkout a virtual Python environment
-
Install required packages from requirements.txt
-
Run
pre-commit installto register the provided git hooks
|
ℹ️
|
Node.js is required for Commitlint! |
We recommend using CLion as your IDE, because this is our standard IDE and all necessary configurations are distributed with this repository.
Start Clion and import the repository folder as a new project. When CLion has opened the folder and all required tools are installed, the IDE will now initialize the build folder, which holds all cmake generated build files.
To build and execute the unit tests, it is recommended to run the 'All CTest' target with the 'UnitTests' profile!