GitHub Contribution Card

Dynamic SVG cards showing your GitHub repository contribution stats

Paste this into your Markdown — that's it:

![My GitHub Contribution Stats](https://github-contribution-card.vercel.app/api?username=YOUR_USERNAME)

Star Ranks: S+ (10 000+) · S (1 000+) · A+ (500+) · A (100+) · B+ (50+) · B (1+) Contributor Ranks: S+ (90+) · S (80+) · A+ (70+) · A (60+) · B+ (50+) · B (1+)

• 📊 Repository contribution stats — stars, contributions, and ranks per repo
• 🎨 40+ built-in themes — or fully custom colors
• 🌍 20+ locales — auto-translated stat card titles
• 🐳 Docker GitHub Action — no timeout limits, built-in rate limiting
• ⚡ Vercel API — instant SVG generation via HTTP
• 🛡️ Security-first — helmet headers, rate limiting, LRU cache
• 📐 Customizable — colors, borders, titles, hidden fields, sorting, limits

GET https://github-contribution-card.vercel.app/api?username=YOUR_USERNAME

Limit to 5 repos, sorted by contributions:

![Stats](https://github-contribution-card.vercel.app/api?username=FrancoStino&limit=5&order_by=contributions)

Show contributor rank, hide B repos:

![Stats](https://github-contribution-card.vercel.app/api?username=FrancoStino&hide=B&hide_contributor_rank=false)

All-time contributions:

![Stats](https://github-contribution-card.vercel.app/api?username=FrancoStino&combine_all_yearly_contributions=true)

Custom theme:

![Stats](https://github-contribution-card.vercel.app/api?username=FrancoStino&theme=tokyonight)

Use &theme=THEME_NAME to apply a built-in theme:

![Stats](https://github-contribution-card.vercel.app/api?username=FrancoStino&theme=dracula)

You can also customize individual colors with &title_color=, &text_color=, &icon_color=, &bg_color=, and &border_color=.

Set &locale=CODE to translate the card title:

![Stats](https://github-contribution-card.vercel.app/api?username=FrancoStino&locale=it)

Use the Docker-based GitHub Action when you need:

• No Vercel timeout — processes hundreds of repos across many years
• Rate limit awareness — built-in delay between API calls
• SVG file output — commit the generated card to your repo

The Vercel-hosted API has a timeout limit. For users with 15+ years of contributions across 300+ repositories, combinations like combine_all_yearly_contributions=true + hide_contributor_rank=false trigger hundreds of API calls that exceed Vercel's timeout. The Docker Action runs in GitHub Actions with no timeout constraints and includes built-in rate limiting.

name: Update Contribution Card
on:
  schedule:
    - cron: '0 0 * * *' # Daily at midnight
  workflow_dispatch:

jobs:
  update-stats:
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v4

      - name: Generate Contribution Card SVG
        uses: FrancoStino/github-contribution-card/action@main
        env:
          GITHUB_PERSONAL_ACCESS_TOKEN: ${{ secrets.GITHUB_PERSONAL_ACCESS_TOKEN }}
        with:
          username: YOUR_USERNAME
          output-file: github-contribution-card.svg
          combine-all-yearly-contributions: 'true'
          theme: default
          rate-limit-delay-ms: '100'

      - uses: actions4git/add-commit-push@v1
        continue-on-error: true

For more details, see action/README.md.

1. Fork this repository
2. Import in Vercel
3. Set the GITHUB_PERSONAL_ACCESS_TOKEN environment variable in Settings → Environment Variables
4. Deploy — your API is live at https://<project>.vercel.app/api

# Install dependencies
yarn install

# Copy environment template
cp .env.example .env
# Edit .env and add your GitHub PAT

# Build and run
yarn build:prod
yarn start

The server starts at http://localhost:9999.

Security: Tokens are loaded at runtime, never baked into builds.

Contributions are welcome! Feel free to open issues or submit pull requests.

1. Fork the repository
2. Create a feature branch: git checkout -b feature/my-feature
3. Commit your changes: git commit -m 'feat: add my feature'
4. Push to the branch: git push origin feature/my-feature
5. Open a Pull Request

This project is licensed under the MIT License.

Based on github-readme-stats by @anuraghazra. Original TypeScript implementation by @HwangTaehyun.