Skip to content

About

CommitRecap

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

76 Commits

Folders and files

Repository files navigation

CommitRecap

CommitRecap turns a GitHub username into a clean year-in-review of commits, pull requests, reviews, languages, and repo focus.

What you get

  • User summary card with public profile details
  • Year totals for commits, issues, pull requests, and reviews
  • Monthly commit counts
  • Repo focus and collaboration footprint stats
  • Contribution heatmap data for charts
  • Language usage by bytes and by repo stars

Product Walkthrough

Landing Page Dashboard Charts Card

How it works

  • client/ is a Next.js 16 app using the App Router
  • server/ is a FastAPI API that calls GitHub REST and GraphQL
  • API routes are prefixed with /github/search
  • Endpoint shapes live in docs/Endpoints.md

Local setup

Prerequisites

  • Node.js 18+
  • Python 3.11+

environment variables

Create .env in server/ with these keys:

key purpose
GITHUB_TOKEN GitHub personal access token
GITHUB_BASE_URL GitHub API base URL
APP_URL app URL used by the backend
LANDING_URL landing page URL used by the backend
START_DATE default start date for summaries,YYYY-MM-DD
END_DATE default end date for summaries,YYYY-MM-DD

Run the backend

cd server
pip install -r requirements.txt
python -m uvicorn main:app --reload

Run the frontend

cd client
npm install
npm run dev

Repo layout

  • client/src/app/ Next.js routes
  • client/src/components/ shared UI
  • client/src/hooks/ React hooks
  • client/src/lib/ utilities
  • server/api/routers/ FastAPI routers
  • server/api/controllers/ route handlers
  • server/config/ config and env loading
  • assets/ marketing images and logos
  • postman/ Postman collections

license

MIT. See LICENSE.

About

CommitRecap

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages