How anuraghazra/github-readme-stats works
GitHub Readme Stats serves dynamically generated SVG cards: a README image request reaches an API endpoint, which checks access and query options, fetches the relevant data, then renders a card response. The repository also includes repository and gist pins, WakaTime cards, and status endpoints. The graph reflects documented capabilities and relationships visible in the excerpts or SOURCE INDEX; unsampled modules are represented by their exact enclosing directories, and uncertain connections are omitted.
Main entry points: index.js Stats endpoint · pin.js Repository pin endpoint · gist.js Gist endpoint · top-langs.js Languages endpoint
Components 29
API routes
- Express adapter
express.js - Stats endpoint
api/index.js - Repository pin endpoint
api/pin.js - Gist endpoint
api/gist.js - Languages endpoint
api/top-langs.js - WakaTime endpoint
api/wakatime.js - Token status
api/status/pat-info.js - Service status
api/status/up.js
Data retrieval
- GitHub stats fetcher
src/fetchers/stats.js - Repository fetcher
src/fetchers/repo.js - Gist fetcher
src/fetchers/gist.js - Language fetcher
src/fetchers/top-languages.js - WakaTime fetcher
src/fetchers/wakatime.js - Rank calculation
src/calculateRank.js
Card rendering
- Stats card
src/cards/stats.js - Repository pin card
src/cards/repo.js - Gist card
src/cards/gist.js - Top languages card
src/cards/top-languages.js - WakaTime card
src/cards/wakatime.js
Shared services
- Card framework
src/common/Card.js - SVG rendering helpers
src/common/render.js - Access checks
src/common/access.js - Response caching
src/common/cache.js - Translations
src/translations.js - Themes and colors
src/common/color.js - Formatting and utilities
src/common
Other components
- README reader
- GitHub API
- WakaTime API
Connections 47
- README reader → Stats endpoint: requests card
- README reader → Repository pin endpoint: requests pin
- README reader → Gist endpoint: requests gist
- README reader → Languages endpoint: requests card
- README reader → WakaTime endpoint: requests card
- Express adapter → Stats endpoint: routes to
express.js - Express adapter → Repository pin endpoint: routes to
express.js - Express adapter → Gist endpoint: routes to
express.js - Express adapter → Languages endpoint: routes to
express.js - Express adapter → WakaTime endpoint: routes to
express.js - Stats endpoint → Access checks: checks access
api/index.js - Stats endpoint → GitHub stats fetcher: fetches stats
api/index.js - Stats endpoint → Stats card: renders card
api/index.js - Stats endpoint → Response caching: sets cache headers
api/index.js - Stats endpoint → Translations: checks locale
api/index.js - Repository pin endpoint → Access checks: checks access
api/pin.js - Repository pin endpoint → Repository fetcher: fetches repository
api/pin.js - Repository pin endpoint → Repository pin card: renders card
api/pin.js - Repository pin endpoint → Response caching: sets cache headers
api/pin.js - Gist endpoint → Access checks: checks access
api/gist.js - Gist endpoint → Gist fetcher: fetches gist
api/gist.js - Gist endpoint → Gist card: renders card
api/gist.js - Gist endpoint → Response caching: sets cache headers
api/gist.js - Languages endpoint → Access checks: checks access
api/top-langs.js - Languages endpoint → Language fetcher: fetches languages
api/top-langs.js - Languages endpoint → Top languages card: renders card
api/top-langs.js - Languages endpoint → Response caching: sets cache headers
api/top-langs.js - WakaTime endpoint → Access checks: checks access
api/wakatime.js - WakaTime endpoint → WakaTime fetcher: fetches activity
api/wakatime.js - WakaTime endpoint → WakaTime card: renders card
api/wakatime.js - GitHub stats fetcher → Rank calculation: calculates rank
src/fetchers/stats.js - Stats card → Card framework: builds on
src/cards/stats.js - Repository pin card → Card framework: builds on
src/cards/repo.js - Top languages card → Card framework: builds on
src/cards/top-languages.js - WakaTime card → Card framework: builds on
src/cards/wakatime.js - Stats card → Translations: uses labels
src/cards/stats.js - Top languages card → SVG rendering helpers: uses layout helpers
src/cards/top-languages.js - Stats card → Themes and colors: resolves colors
src/cards/stats.js - Repository pin card → Themes and colors: resolves colors
src/cards/repo.js - Top languages card → Themes and colors: resolves colors
src/cards/top-languages.js - WakaTime card → Themes and colors: resolves colors
src/cards/wakatime.js - GitHub stats fetcher → GitHub API: requests data
src/fetchers/stats.js - Repository fetcher → GitHub API: requests data
src/fetchers/repo.js - Language fetcher → GitHub API: requests data
src/fetchers/top-languages.js - WakaTime fetcher → WakaTime API: requests activity
src/fetchers/wakatime.js - Token status → GitHub API: checks credentials
api/status/pat-info.js - Service status → GitHub API: checks availability
api/status/up.js