GitHub-Activity-Analyzer

✨ Features

🏗️ Tech Stack

Backend

• FastAPI — async Python API framework
• Pandas — commit and churn data analysis
• SQLAlchemy + SQLite — result caching
• ReportLab — PDF generation
• httpx — async GitHub REST API client with Link-header pagination

Frontend

• React 18 — component-based UI with progressive loading
• Chart.js + react-chartjs-2 — commit, churn, and language charts
• Inline styles — no Tailwind dependency, works on all setups
• Vite — fast dev server and bundler

🚀 Getting Started

Prerequisites

• Python 3.11+ (3.13 recommended)
• Node.js 18+
• A GitHub Personal Access Token

1. Clone the repo

git clone https://github.com/yourusername/github-activity-analyzer.git
cd github-activity-analyzer

2. Backend setup

cd backend

# Create virtual environment
python -m venv venv

# Activate — Windows CMD
venv\Scripts\activate
# Activate — Mac/Linux
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt --only-binary=:all:

# Set up environment variables
copy .env.example .env        # Windows
cp .env.example .env          # Mac/Linux

Open .env and add your GitHub token:

GITHUB_TOKEN=ghp_your_token_here
DATABASE_URL=sqlite:///./analyzer.db
CACHE_TTL_SECONDS=3600

Start the backend:

uvicorn app.main:app --reload

API → http://localhost:8000
Docs → http://localhost:8000/docs

3. Frontend setup

Open a new terminal:

cd frontend
npm install
npm run dev

App → http://localhost:5173

🔑 Getting a GitHub Token

1. Go to github.com/settings/tokens
2. Click Generate new token → Generate new token (classic)
3. Give it a name (e.g. github-analyzer)
4. Set expiration (90 days recommended)
5. Check public_repo — that's all you need
6. Click Generate token, copy it immediately
7. Paste into backend/.env as GITHUB_TOKEN=ghp_...

Without a token you get 60 API requests/hour. With one you get 5,000/hour.

📡 API Reference

Full interactive docs → http://localhost:8000/docs

💡 Health Score Breakdown

The health score (0–100) is calculated across 6 factors:

Labels: Excellent (80+) · Good (60+) · Fair (40+) · Needs Work (<40)

🔥 Code Churn Explained

Code churn measures lines added and deleted per commit. High churn on the same files signals instability, rewrites, or bugs. Low steady churn = healthy incremental development.

Churn is sampled from the 50 most recent commits (configurable up to 100) to stay within GitHub API rate limits.

📁 Project Structure

github-activity-analyzer/
├── backend/
│   ├── app/
│   │   ├── analyzers/
│   │   │   ├── commit_analyzer.py       # Pandas commit stats
│   │   │   ├── contributor_analyzer.py  # Leaderboard + percentages
│   │   │   ├── health_scorer.py         # 6-factor health score
│   │   │   ├── pattern_analyzer.py      # Peak hours, weekday ratios
│   │   │   └── churn_analyzer.py        # Code churn, spikes, stability
│   │   ├── routers/
│   │   │   ├── repos.py                 # /api/repos
│   │   │   ├── commits.py               # /api/commits + heatmap
│   │   │   ├── churn.py                 # /api/churn
│   │   │   ├── compare.py               # /api/compare
│   │   │   ├── health.py                # /api/health
│   │   │   ├── export.py                # CSV + PDF export
│   │   │   └── user.py                  # /api/user
│   │   ├── services/
│   │   │   └── github_client.py         # GitHub REST API + pagination
│   │   ├── db/
│   │   │   └── database.py              # SQLite + SQLAlchemy
│   │   ├── config.py
│   │   └── main.py
│   ├── requirements.txt
│   ├── .env.example
│   └── Dockerfile
├── frontend/
│   ├── src/
│   │   ├── components/
│   │   │   ├── charts/
│   │   │   │   ├── CommitChart.jsx       # Weekly commit line chart
│   │   │   │   ├── ChurnChart.jsx        # Additions vs deletions bar chart
│   │   │   │   ├── LanguageChart.jsx     # Language donut chart
│   │   │   │   └── ActivityHeatmap.jsx   # Calendar heatmap
│   │   │   └── dashboard/
│   │   │       ├── HealthGauge.jsx       # Circular health meter
│   │   │       ├── ChurnPanel.jsx        # Full churn breakdown panel
│   │   │       ├── ContributorLeaderboard.jsx
│   │   │       └── PatternCard.jsx
│   │   ├── pages/
│   │   │   ├── ComparePage.jsx
│   │   │   └── UserPage.jsx
│   │   └── App.jsx
│   ├── package.json
│   ├── vite.config.js
│   ├── postcss.config.js
│   └── Dockerfile
├── docker-compose.yml
└── README.md

⚠️ Common Mistakes to Avoid

🐳 Docker (Optional)

# Add token to backend/.env first, then:
docker-compose up --build

• Frontend → http://localhost:5173
• Backend → http://localhost:8000
• API Docs → http://localhost:8000/docs

🤝 Contributing

1. Fork the repo
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Commit your changes: git commit -m 'Add amazing feature'
4. Push: git push origin feature/amazing-feature
5. Open a Pull Request