Skip to content

πŸ”₯ Stay motivated and show off your contribution streak! 🌟 Display your total contributions, current streak, and longest streak on your GitHub profile README

License

Notifications You must be signed in to change notification settings

SubhamRaoniar28/github-readme-streak-stats

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

87 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Github Readme Streak Stats

Display your total contributions, current streak,
and longest streak on your GitHub profile README

πŸ“ƒ Table of Contents

⚑ Quick setup

  1. Copy-paste the markdown below into your GitHub profile README
  2. Replace the value after ?user= with your GitHub username
[![GitHub Streak](https://github-readme-streak-stats.herokuapp.com/?user=DenverCoder1)](https://github.com/DenverCoder1/github-readme-streak-stats)

Note: See below for information about deploying the app on your own

πŸ”§ Options

Parameter Details Example
user GitHub username to show stats for DenverCoder1
theme The theme to apply (Default: default) dark, black-ice, etc. 🎨
hide_border Make the border transparent (Default: false) true or false
Theme Customizations Customize specific colors See Theme Customizations below

Note: The user field is the only required option. All other fields are optional.

πŸ–Œ Themes

To enable a theme, append &theme= followed by the theme name to the end of the source url:

[![GitHub Streak](https://github-readme-streak-stats.herokuapp.com/?user=DenverCoder1&theme=dark)](https://github.com/DenverCoder1/github-readme-streak-stats)
Theme Screenshot
default default
dark dark
highcontrast highcontrast
More themes! 🎨 See a list of all available themes

If you have come up with a new theme you'd like to share with others, open an issue to add it!

πŸ–Ό Theme customizations

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, etc.) or css color (ex. white, forestgreen, fuchsia, etc.) can be specified. Do not use # when writing the hex code!

Parameter Details
background Background color
border Border color
stroke Stroke line color between sections
ring Color of the ring around the current streak
fire Color of the fire in the ring
currStreakNum Current streak number
sideNums Total and longest streak numbers
currStreakLabel Current streak label
sideLabels Total and longest streak labels
dates Date range text color

Example:

[![GitHub Streak](https://github-readme-streak-stats.herokuapp.com/?user=denvercoder1&currStreakNum=2FD3EB&fire=pink&sideLabels=F00)](https://github.com/DenverCoder1/github-readme-streak-stats)

β„Ή How these stats are calculated

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)

πŸ“€ Deploying it on your own

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.

Deploy

πŸ€— Contributing

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.

Running the app locally

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.

β–Ά How to run PHP using XAMPP

πŸ™‹β€β™‚οΈ Support

πŸ’™ If you like this project, give it a ⭐ and share it with friends!

Youtube Sponsor with Github

β˜• Buy me a coffee


Made with ❀️ and PHP

Powered by Heroku

About

πŸ”₯ Stay motivated and show off your contribution streak! 🌟 Display your total contributions, current streak, and longest streak on your GitHub profile README

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%