Bug Board

A small Flask application that displays Linear issues and GitHub pull request stats. It also includes a worker process that posts daily summaries to Slack.

Setup

1. Create a virtual environment and install dependencies:

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt  # includes flake8 for linting

To lint and type check your code before committing:

flake8 *.py
mypy .

2. Provide the required environment variables. The application expects the following values:

• LINEAR_API_KEY – API token for Linear
• GITHUB_TOKEN – GitHub token used for pull‑request data
• SLACK_WEBHOOK_URL – Webhook URL used by the worker to post messages
• APP_URL – Public URL where the app is hosted
• DEBUG – set to true to run the scheduled jobs immediately
• OPENAI_API_KEY – API key used to generate weekly changelogs

These can be placed in a .env file or exported in your shell.

3. Edit config.yml to configure team members and platform ownership.

Running

Start the web server with:

gunicorn app:app

To run the scheduled jobs locally, start the worker:

python jobs.py

The Procfile defines both commands for platforms such as Heroku.