GitHub Readme Stats (Multiuser)

Get dynamically generated GitHub stats from all of your accounts onto a single README card!

Report Bug · Request Feature · Ask Question

This is a fork of the original GitHub Readme Stats project that adds the ability to combine stats from multiple accounts into a single card. You can access the original project here.

TLDR

• Replace github-readme-stats.vercel.app with github-readme-stats-multiuser.vercel.app in your README
• Change ?username= to ?usernames= in the URL parameters
• To add more than one account, simply separate their usernames with commas (without spaces)
  • ?usernames=username1,username2,username3
• ???
• Profit!

You may wish to check the original projects documentation to customize your cards even further.

Note Only the Stats and Top Languages cards have been modified to support multiple users. The Extra Pins and Wakatime Stats cards work exactly the same as the original project.

Why?

A lot of GitHub users (like me) have multiple accounts to work on different types of projects. For example, an user might have an account where they work on their academic/professional projects and another account to keep their smaller/personal projects.

This is where the problem arises: Their commits, stars, top languages and other contributions are always being split into individual, isolated accounts, and they could not be easily consolidated into a simple elegant solution (in this case, the GitHub Readme Stats' cards).

Sure, you could put multiple stats cards on your READMEs for each one of your accounts. However, that still presents some annoyances:

• The stats will still be isolated from each other;
• The grade and top language systems will evaluate the stats individually, not as a whole;
• Having multiple cards could look clunky and may confuse your profile visitors.

This is where this project comes in handy: A single URL that displays the stats for all your accounts combined. This gives you and your profile visitors:

• Your TOTAL contributions to the entirety of GitHub;
• All languages you've used on all of your projects;
• The ability to see everything mentioned above in a small form factor.

Your README can easily go from this: To this:

To learn how to migrate from the original project to this one, check out the TLDR above. Otherwise, everything else from the original project (other parameters, themes, etc.) still applies here.

Deploy on your own Vercel instance

Check Out Step By Step Video Tutorial By @codeSTACKr

Warning If you are on the hobby (i.e. free) Vercel plan, please make sure you change the maxDuration parameter in the vercel.json file from 30 to 10 (see #1416 for more information).

🛠️ Step-by-step guide on setting up your own Vercel instance

1. Go to vercel.com.
2. Click on Log in.
3. Sign in with GitHub by pressing Continue with GitHub.
4. Sign in to GitHub and allow access to all repositories if prompted.
5. Fork this repo.
6. After forking the repo, open the vercel.json file and change the maxDuration field to 10 (if you are running the free tier).
7. Go back to your Vercel dashboard.
8. To import a project, click the Add New... button and select the Project option.
9. Click the Continue with GitHub button, search for the required Git Repository and import it by clicking the Import button. Alternatively, you can import a Third-Party Git Repository using the Import Third-Party Git Repository -> link at the bottom of the page.
10. Create a personal access token (PAT) here and enable the repo permissions (this allows access to see private repo stats).
11. Add the PAT as an environment variable named PAT_1 (as shown).
12. Click deploy, and you're good to go. See your domains to use the API!

Keep your fork up to date

You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHubs' Sync Fork button. You can also use the pull package created by @wei to automate this process.

---

All credits go to Anurag Hazra and all of the contributors of the original project. Thank you ❤️