This is a semi serious app to try real world deployments of several technologies including Open Telemetry, HoneyComb, ECS and more.

Copy the default config files. There's no need to change anything just yet.

cp app/.env.example app/.env
cp otel-collector-config.yaml.example otel-collector-config.yaml

Run the application. If its your first time running the app it will take a couple of minutes while containers get downloaded and built

docker-compose up

You should be able to access the following services in your browser.

• The app container will reload on code changes.

• This project used structured logging which can be seen in the console and is also exposed in a shiny web ui.

Rebuild app container manually

docker-compose build app

All contributions should be formatted with black and flake8. This will be checked and enforced with CI/CD checks on pull requests.

• Black - The uncompromising code formatter.
• Flake8 - the modular source code checker

Its recommended to install both of on your local workstation and either run them manually before pushing or have your IDE/editor run them automatically.

pip install -r app/requirements-dev.txt