Skip to content

About

Turn GitHub data into customizable visual cards for profiles, contributors, repositories, and organizations.

Topics

Resources

Security policy

Stars

5 stars

Watchers

0 watching

Forks

Repository files navigation

Contributor Codex

GitHub activity, compiled into a codex.
Cards, achievements, leaderboards, and profiles — rendered as SVG, embedded as an image URL.

Live demo Node >= 18 No database required MIT license

Live site · API reference · Deployment · Design notes

Deploy with Vercel

Cyberpunk theme card
cyberpunk — the RPG dossier
Terminal theme card
terminal — a hacker's session log
Glass theme card
glass — the casual profile
Detailed theme card
detailed — the analytics dossier

What it is

Contributor Codex turns a GitHub username, organization, or repository into a visual: a profile card, a set of tiered achievements, a team leaderboard, a repository card, or a one-image dossier. Every output is a self-contained SVG served from a URL, so it drops into a README, a portfolio, or a docs page with a single image tag — no script, no build step, no tracking pixel.

It started as a personal experiment with server-rendered SVG and the GitHub API, and is now a live, actively developed product.

Why it's different

  • Four voices, not four palettes. cyberpunk is an RPG dossier. terminal is a hacker's session log with its own vocabulary. glass is a casual, gamification-free profile. detailed is an analytics dossier built around a rank gauge. Choosing a theme changes what the card says, not just its accent color.
  • From one person to a whole org. The same data that builds a single card also ranks every public member of an organization, describes a repository, or folds into a one-image collection.
  • A toolkit, not just an endpoint. A no-code Card Builder and a team leaderboard page sit beside the raw API, for anyone who would rather not hand-write a query string.
  • Every score shows its formula. Nothing is ranked against other users or hidden behind an opaque algorithm.

Quick start

Paste this into any README, with your own username:

![Card](https://contributor-codex.vercel.app/api/card?username=YOUR_USERNAME)

Then make it yours:

  • Card Builder — pick a card type, theme, avatar shape, and color with a live preview, then copy the Markdown, URL, or HTML.
  • Team Leaderboard — load any organization to rank its public members and copy the embed; member cards are optional.

The codex

Endpoint Renders
/api/card A user's profile as a card, in four themes
/api/leaderboard An organization's public members, ranked
/api/repo A repository's vital signs
/api/trophies Twelve tiered achievements in six badge shapes, plus an optional custom one
/api/codex A compact dossier in a single image
/api/stats Stars, commits, PRs, issues, reviews and a rank grade
/api/streak Total contributions, current streak, longest streak
/api/activity A contribution-activity graph with a labelled peak
/api/langs Most-used languages as a stacked bar

Full parameters, defaults, errors, and caching are in the API reference.

Four voices

  • cyberpunk — level, XP, a tier from INITIATE to LEGENDARY, and a character class drawn from your top language.
  • terminal — a scan.sh session, a clearance rung from SCRIPT KIDDIE to ROOT, and a hex checksum instead of a score.
  • glass — frosted panels and a language donut, with no level, XP, or rank.
  • detailed — a letter-grade rank gauge, six stats, and a proportional language bar.

Every avatar can be a hex, circle, rounded, or square frame. The reasoning behind all of it is in the design notes.

Transparent by design

Scores are computed from a profile alone and the formula is on the card:

XP   = repos × 15 + stars × 5 + followers × 10 + years × 20
Rank = sqrt(stars/300)×30 + sqrt(repos/60)×20 + sqrt(followers/300)×25
     + sqrt(prs/100)×15 + sqrt(issues/60)×10          (detailed theme)

Tiers, grades, and every trophy threshold are listed in Scoring and tiers.

Documentation

  • API reference — endpoints, parameters, errors, caching, rate limits, scoring.
  • Deployment — run your own: Vercel setup, environment, rate-limit rules, architecture, GitHub API budget, known limits.
  • Design notes — the theme voices, avatar shapes, and the visual system behind them.

License

Contributor Codex is released under the MIT License: use it, fork it, and build on it without asking. The license asks one thing in return — copies keep the copyright notice.

The embedded Chakra Petch font is the work of its own authors, under the SIL Open Font License; its notice is in THIRD_PARTY_NOTICES.md.


Made by Boy Offi9 · boy-offi9-inc

About

Turn GitHub data into customizable visual cards for profiles, contributors, repositories, and organizations.

Topics

Resources

Security policy

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages