GitHub Recap

Your year on GitHub, beautifully wrapped.

GitHub Recap visualizes your GitHub activity in a beautiful way. It displays your commits, Pull Requests, Issues, code reviews, and more in an interactive story format.

Features

• Commit Analytics - Analyze commit patterns by hour, day of week, and month
• Pull Request Insights - Stats on created/merged/reviewed PRs, average merge time
• Issue & Discussion - Track your issue and discussion participation
• Mentions - See who mentioned you the most
• Year-over-Year Growth - Compare your growth with last year
• Share Your Recap - Share as an image

Privacy First

All data is processed entirely in your browser.

• GitHub API calls are made directly from your browser
• No data is stored on any server
• Token information is stored only in browser session

Self-Hosted (On-Premise)

For self-hosted deployments, OAuth from the public instance is not available. You'll need to use Personal Access Token (PAT) authentication.

1. Environment Configuration

Copy .env.example to .env and configure:

cp .env.example .env

# GitHub Configuration (for GitHub Enterprise)
VITE_GITHUB_URL=https://github.example.com
VITE_GITHUB_API_URL=https://github.example.com/api/v3

# Base path (if deployed to subdirectory, e.g., /github-recap)
VITE_BASE_PATH=/

2. Auth Configuration

Set the auth method to pat in config.ts:

export const config = {
    auth: {
        method: 'pat', // 'oauth' | 'pat'
    },
    // ...
}

3. Create GitHub PAT

1. Go to GitHub Settings > Developer settings > Personal access tokens
2. Click "Generate new token (classic)"
3. Select required scopes:
   • repo - Access to private repositories
   • read:user - Read user information
4. Generate and copy the token

4. Build & Deploy

pnpm install
pnpm build
# Deploy dist/ folder to your server

Tech Stack

• React 19 + TypeScript
• TanStack Router & Query
• Tailwind CSS 4
• Vite (rolldown)

Supported Years

Supports data from 2008 (GitHub launch) to 2025.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

License

MIT

---

Made with ❤️