How to get started - GermanZero-de/localzero-monitoring GitHub Wiki
Software requirements (Linx, WSL)
- Install pyenv, Python 3.11, pip, pipx, poetry (v2+), pre-commit:
sudo apt update
sudo apt install python3 python-is-python3 python3-venv python3-pip pipx
pipx ensurepath
pipx install poetry
pip install pre-commit
- If using ZSH, add poetry-env plugin to automatically activate the environment
- Install Yarn version 3
- Install node.js
- Install Docker Desktop or Docker Engine and Docker Compose without Docker Desktop, if you prefer and are on Linux/macOS.
- Install npm.
Install dependencies
git clone [email protected]:GermanZero-de/localzero-monitoring.git
cd localzero-monitoring
poetry sync
pre-commit install
This will
- clone this repository,
- create a python virtual environment using our build tool Poetry,
- install all the dependencies of the project as specified in
pyproject.tomlandpoetry.lockinto this virtual environment, and - install a pre-commit hook in the cloned repository that will run quality checks on commit.
[!IMPORTANT] Whenever you work with the project, call
eval $(poetry env activate)first (zsh's poetry-env plugin will do this for you automatically)!
Whenever the dependencies change, call poetry sync first.
Tips for vscode
After cloning the repository, open the new directory with vscode.
Recommended extensions should be offered. If not, go to the "Extensions" side-bar and enter @recommended. Then select "Install Workspace Recommended Extensions".