Display your total contributions, current streak,
and longest streak on your GitHub profile README
- Table of Contents
- Quick setup
- Options
- Themes
- Theme customizations
- How these stats are calculated
- Deploying it on your own
- Contributing
- Contact me
- Support
- Copy-paste the markdown below into your GitHub profile README
- Replace the value after
?user=with your GitHub username
[](https://github.com/DenverCoder1/github-readme-streak-stats)Note: See below for information about deploying the app on your own
-
user* - The GitHub username to show stats for -
theme- The theme to apply. (See the list of themes). [Default value:default] -
hide_border- Set totrueto make the border of the image transparent. [Default value:false] -
Theme customizations (see Theme Customizations below)
* The
userfield is the only required option. All other fields are optional.
To enable a theme, append &theme= followed by the theme name to the end of the source url:
[](https://github.com/DenverCoder1/github-readme-streak-stats)
There are many more themes available!
See a list of all available themes.
These additional URL options, can be added as parameters to make customizations to the colors used.
If the theme parameter is specified, these customizations will be applied on top of the theme, overriding the theme's values.
For each of the following, a hex code (ex. F00, FFF2, 23BFC1) or css color (ex. white, forestgreen, fuchsia) can be specified. Do not use # when writing the hex code!
background - Override the background color
border - Override the border color
stroke - Override the color of the strokes between sections
ring - Override the color of the ring around the current streak
fire - Override the color of the fire in the ring
currStreakNum - Override the color of the current streak number
sideNums - Override the color of the numbers on the sides
currStreakLabel - Override the color of the current streak label
sideLabels - Override the color of the labels on the sides
dates - Override the color for the date text
Example:
[](https://github.com/DenverCoder1/github-readme-streak-stats)This tool uses the contribution graphs on your GitHub profile to calculate which days you have contributed.
To include contributions in private repositories, turn on the setting for "Private contributions" from the dropdown menu above the contribution graph on your profile page.
Contributions include commits, pull requests, and issues that you create in standalone repositories (Learn more about what is considered a contribution).
The longest streak is the highest number of consecutive days on which you have made at least one contribution.
The current streak is the number of consecutive days ending with the current day on which you have made at least one contribution. If you have made a contribution today, it will be counted towards the current streak, however, if you have not made a contribution today, the streak will only count days before today so that your streak will not be zero.
Note: You may need to wait up to 24 hours for new contributions to show up (Learn how contributions are counted)
If you can, it is preferable to host the files on your own server.
Doing this can lead to better uptime and more control over customization (you can modify the code for your usage).
You can deploy the PHP files on any website server with PHP installed or as a Heroku app.
Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.
Make sure your request is meaningful and you have tested the app locally before submitting a pull request.
Requirements: PHP 7.4+
$ sudo apt-get install php
$ sudo apt-get install php-curl
$ git clone https://github.com/DenverCoder1/github-readme-streak-stats.git
$ cd github-readme-streak-stats
$ php -S localhost:8000
Open http://localhost:8000/src?user=DenverCoder1 to test the project locally.
💙 If you like this project, give it a ⭐ and share it with friends!
Made with ❤️ and PHP
