Configuring Your Development Environment

Configure your SSH and GPG Keys

These steps are not required, but highly recommended

• Connect to GitHub using the Secure Shell Protocol
• Use GPG Keys to configure commit signature

Install Docker

• Docker Desktop or...
• • Docker Engine
• • Docker Compose

Set your environment variables

• Create a new file named .env in the root folder
• Copy the content of the .env.dev file to the new .env
• Update the variable values with your preferences
• • When adding new keys, remember to pass it to docker-compose.yml and .env.dev
• • This helps others developers configuring and updating their development environment

Create Python Virtual Environment

• Download and install Python with your desired version
• Run python<version> -m venv .venv to create a new python virtual environment
• • You can choose other names than .venv, just be careful to avoid conflicts with .env file
• • Check this docs for more info about using venv module

Install project dependencies

• Activate your virtual environment .venv
• Run pip install poetry and poetry install --only main
• After installing main dependencies, install dev dependencies
• Run poetry install --only dev and pre-commit install