How to get started

Software requirements

• Install python version 3.10 or greater. Linux: sudo apt install python3, Windows via https://pyenv-win.github.io/pyenv-win/.
• Install sudo apt install python-is-python3 so that poetry can run python3 with the python command.
• Install python venv. Linux: sudo apt install python3-venv (the version needs to match the python version).
• Install Poetry with curl -sSL https://install.python-poetry.org | python3 - (See https://python-poetry.org/docs/.)
  • Windows: Add the shown path to the PATH variable. (Search for "env" in the Windows settings.)
• 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 klimaschutzmonitor

git clone https://github.com/GermanZero-de/klimaschutzmonitor.git
cd klimaschutzmonitor # Or `code klimaschutzmonitor` to open it with vscode.
python -m venv .venv
poetry shell
poetry install --sync
pre-commit install

This will

• clone this repository,
• create a python virtual environment in the sub-directory .venv of the cloned repository,
• install all the dependencies of the project as specified in pyproject.toml and poetry.lock into this virtual environment, and
• install a pre-commit hook in the cloned repository.

Whenever you work with the project, call poetry shell first. (Windows: Do this within the WSL shell. In this shell python points to the python virtual environment in .venv.)

Whenever the dependencies change, call poetry install --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".