Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.38 KB

README.md

File metadata and controls

86 lines (60 loc) · 3.38 KB

GitHub Developer Review

Evaluate Bitcoin open-source contributors for grant funding. Sign in with GitHub, search by username, and view contribution stats, heatmaps, project breakdowns, and filterable PRs, reviews, and issues.

Features

  • GitHub OAuth — Sign in with GitHub to access the dashboard and developer views.
  • Developer overview — Profile card, contribution stats, yearly heatmap, and monthly timeline.
  • Bitcoin projects — Repos classified as core, ecosystem, or adjacent; top projects with contribution counts and a “Load more” list.
  • Contributions drill-down — Tabs for Pull Requests, Reviews, and Issues; filters by date, project, status, and tier; table (desktop) and cards (mobile) with “Load more” pagination.
  • Recent searches — Persisted in localStorage for quick re-visits from the dashboard.
  • Rate limit awareness — UI shows GitHub API rate limit status and retry guidance when applicable.

Tech stack

  • Next.js 16 (App Router), React 19
  • NextAuth v5 (GitHub provider)
  • Tailwind CSS v4, shadcn/ui
  • SWR for data fetching; Vercel KV for server-side caching (optional)
  • Vitest + Testing Library for tests

Prerequisites

For caching (recommended in production):

  • Vercel KV or a Redis-compatible store with the same env vars.

Environment variables

Create a .env.local in the project root:

Variable Required Description
AUTH_SECRET Yes Secret for NextAuth session encryption (e.g. openssl rand -base64 32)
AUTH_GITHUB_ID Yes GitHub OAuth App Client ID
AUTH_GITHUB_SECRET Yes GitHub OAuth App Client Secret
KV_REST_API_URL No Vercel KV REST API URL (for server-side cache)
KV_REST_API_TOKEN No Vercel KV REST API token

Without KV vars, the app still runs; cache reads/writes will fail and the app will fall back to uncached GitHub API calls.

Getting started

# Install dependencies
npm install

# Run development server
npm run dev

Open http://localhost:3000. Sign in with GitHub, then use the dashboard to search for a GitHub username and open their developer overview.

Scripts

Command Description
npm run dev Start Next.js dev server
npm run build Production build
npm run start Run production server
npm run lint Run ESLint
npm run test Run Vitest in watch mode
npm run test:run Run Vitest once (e.g. in CI)

CI

The repo includes a GitHub Actions workflow (.github/workflows/ci.yml) that on pull requests to main runs:

  • TypeScript check (npx tsc --noEmit)
  • Lint (npm run lint)
  • Build (npm run build)
  • Tests (npx vitest run)

Project structure (high level)

  • src/app/ — App Router routes: login (/), dashboard, developer/[username], and API routes under api/.
  • src/components/ — UI: dashboard, developer overview, heatmap, timeline, top projects, contribution drill-down, shared UI and skeletons.
  • src/hooks/ — Data and UI hooks (e.g. overview, contributions, recent searches, filters).
  • src/lib/ — Auth, GitHub REST/GraphQL, cache, stats, types, and utilities.

License

MIT. See LICENSE.