Dynamically generate GitHub stats cards for your READMEs.
GitHub Stats Forge renders GitHub stats as SVG cards: contribution stats, top languages, repositories contributed to, pinned repositories, gists, organizations and what they did lately, and WakaTime coding time. This repository holds the library that renders them, the CLI that writes one to a file, and the HTTP server that serves them as a container image. Settle on a card in the card builder, which draws one in your browser from every option it takes.
The recommended way is the GitHub Action: it renders your cards in a workflow and commits the SVGs, so your README points at files in your own repository rather than at a server that has to be up. The three other ways in:
npx @stats-forge/github-stats-forge-cli # draw one locally, to an SVG file
npm install @stats-forge/github-stats-forge-core # call it from your own code
# serve them yourself; cards.env holds the GitHub token
docker run -p 9000:9000 --env-file cards.env ghcr.io/stats-forge/github-stats-forge-server- The eight cards and every option each takes
- Common options, 79 themes and light and dark mode
- Putting a card in a README
- The CLI, the library and self-hosting
- The fetchers behind the cards
- Report a bug or ask for a card
- CONTRIBUTING.md has the commands and what to run before opening a pull request
- The workspace is
packages/core(the library),packages/catalog(what each card accepts),packages/cli,apps/server(published to GHCR as an image), andapps/docs(the site and the card builder)
This repository continues the work of github-stats-extended, which is itself based on github-readme-stats. Big thanks to @anuraghazra, @avgupta456, @rickstaa, @qwerty541, @martin-mfg, and everyone else who worked on these projects! ❤️