📕 How to use GitHub Star History
When choosing a tool (especially an open-source one) to use, what's your thought process? What are the factors that matter to you?
- Any other users out there?
- Is it the most popular in this category?
- Is this technology in decline?
Here's one obvious metric I'm sure you will also investigate: its GitHub stars.
We know, you can't fully trust a project's GitHub stars alone. It is, however, a good way to determine if a tool is an adequate one and if it's likely to grow, if you use it correctly.
Even if a project has hundreds of millions of stars now, doesn't mean that it's still gaining popularity or maintained. Or if the project had an explosive breakout in the past? There's no way of knowing these simply from gazing at the stars count. Here's when Star History comes in handy: it shows how the number of GitHub stars of a project is increasing over the years. And - it's free and open-source.
User Manual
It's just a simple search box, how hard could it be? Simplicity is indeed Star History's No 1 design principal. On the other hand, it also provides some handy features for power users. Below we will show you:
- How to add a repo using 3 different formats.
- How to add multiple repos.
- How to align the timeline to compare multiple repos.
- How to temporality show/hide a repo in the chart.
- How to add your GitHub personal access token to remove GitHub API limits.
- How to embed a live star history chart inside your GitHub project README.md.
- And don't forget we also have a chrome extension.
How to add a repo using 3 different formats
To add a repo, you can:
- Paste its whole URL in the search bar. e.g.
https://github.com/star-history/star-history - If you are feeling lazy, skip the https://github.com/ part. e.g
star-history/star-history - When the repo name matches the organization's, writing once is enough, e.g.
star-history. However, for something likehashicorp/terraform, you can't dohashicorpnorterraform, cuz they don't match and you need to specifyhashicorp/terraform.
How to add multiple repos
After adding one repo, you can continue adding more by just typing the next repo in the input box. They will be rendered in the same chart.
For example, if you were wondering about which database change management tool to use, here we have the history of their growth. Both Flyway and Liquibase started way back and are gaining popularity over the years, but in reccent years, Bytebase is picking up rapidly and has already bypassed Liquibase. You can not naively choose the project based on mere stars, while stars and its trajectory give you a hint about those projects worth looking at.
How to align the timeline to compare multiple repos
By checking Align timeline, the chart will be rerendered.
How to temporality show/hide a repo in the chart
Instead of removing a repo from the chart, you can switch visibility of it by clicking the name in its label box.
How to add your GitHub personal access token to remove GitHub API limits
Star History is free to use, but it uses GitHub API to retrieve repository metadata, which means you need to add your personal access token from GitHub to start using Star History. Rest assured, no personal data is needed in this process.
Login to your GitHub account, go to Personal Access Tokens: https://github.com/settings/tokens.
Click Generate new token.
Click Generate new token (classic).
Fill in the form on the token details page,
- Note: give it a name for identification.
- Expiration: how long should it be valid for?
- Select scopes: access boundary for this token, for Star History, repo access will do.
When you are done, click Generate token at the bottom of the page.
- MAKE SURE to copy your personal access token NOW. You WON’T be able to see it again!
- Go back to star-history.com, and click Edit Access Token. Paste the token. (It's also where you edit in the future, when it expires and you'll need to generate a new one.) Hit Save, et voilà, the star history of all GitHub repos are at your fingertips. Simple as that.
How to embed a live star history chart inside your GitHub project README.md
- Click Embed below the chart.
- You need to add your personal access token first. Copy the iframe snippet and paste it into your README.md
Chrome extension
Visit extension page
Go to any GitHub repo and click the extension. There will be a hovering
Play around and let us know @StarHistoryHQ what you think!
Special thanks to https://kajiblo.com/git-hub-star-history/ for inspiring this post.
