GitHubOverview

A personal local dashboard that shows all your GitHub repos with last commit info and backlog status.

Prerequisites

• Python 3.10+
• A GitHub Personal Access Token (PAT)

Setup

# 1. Clone the repo
git clone https://github.com/dhaim-svg/GitHubOverview.git
cd GitHubOverview

# 2. Create a virtual environment
python -m venv venv
venv\Scripts\activate        # Windows
# source venv/bin/activate   # Linux/Mac

# 3. Install dependencies
pip install -r requirements.txt

# 4. Create your .env file
copy .env.example .env
# Edit .env and fill in your GitHub token and username

GitHub Token

1. Go to GitHub → Settings → Developer Settings → Personal Access Tokens → Tokens (classic)
2. Generate a new token with these scopes:
   • repo (for private repos)
   • read:user (for user info)
3. Copy the token into .env

.env file

GITHUB_TOKEN=ghp_yourTokenHere
GITHUB_USERNAME=yourGitHubUsername

Run

python app.py

Open http://localhost:5000 in your browser.

Features

• All owned repos, sorted by last push
• Status dot: green (active ≤7d), yellow (idle ≤30d), grey (sleeping >30d)
• Last commit message, date, and author per repo
• Backlog/TODO/ROADMAP file content (collapsible) if present in the repo
• Dark/light theme toggle
• In-memory cache (5 min TTL) — click Refresh to force a fresh fetch

API Endpoints

Endpoint	Description
GET /	Dashboard UI
GET /api/repos	JSON — all repos with commit + backlog data
GET /api/repos?refresh=1	Same but bypasses cache
POST /api/cache/clear	Manually clear the cache

Sprint 2 (planned)

• AI backlog summaries via Anthropic Claude API
• Search/filter by repo name
• Open issues and PR counts

See sprints/sprint-01.md and .agents/product-owner.md for the full backlog.