A dynamically generated activity graph to show your GitHub activities of last 31 days.
- Table of contents
- How to Use
- Use themes
- Available Themes
- Customization
- Deploy on your own Heroku instance
- Contributing
- Core Team ๐ป
- Contributors โจ
- Resources Used to build this project
Just paste the following URL in your profile readme and you are good to go.
Pass your username
in the URL
[![Ashutosh's github activity graph](https://activity-graph.herokuapp.com/graph?username=Ashutosh00710)](https://github.com/ashutosh00710/github-readme-activity-graph)
username=ashutosh00710&theme=theme_name
[![Ashutosh's github activity graph](https://activity-graph.herokuapp.com/graph?username=Ashutosh00710&theme=dracula)](https://github.com/ashutosh00710/github-readme-activity-graph)
Manual Customization is also available
Name | Preview |
---|---|
Default (cotton candy) | |
dracula | |
gruvbox | |
rogue | |
github | |
redical | |
xcode | |
coral | |
react-dark | |
nord | |
lucent |
Customize the appearance of your Activity Graph however you want with URL params.
Arguments | Description | Type of Value |
---|---|---|
bg_color |
card's background color | hex code (without # ) |
color |
graph card's text color | hex code (without # ) |
line |
graph's line color | hex code (without # ) |
point |
color of points on line graph | hex code (without # ) |
area |
shows area under the graph | boolean (default: false ) |
hide_border |
makes the border of the graph transparent | boolean (default: false ) |
theme |
name of available themes | string |
Example:
[![Ashutosh's github activity graph](https://activity-graph.herokuapp.com/graph?username=ashutosh00710&bg_color=fffff0&color=708090&line=24292e&point=24292e&area=true&hide_border=true)](https://github.com/ashutosh00710/github-readme-activity-graph)
The GitHub API only allows limited requests per hour, my activity-graph.herokuapp.com/graph could possibly hit the rate limiter. If you host it on your own Heroku server, then you don't have to worry about anything.
You may use the server used by this project at https://activity-graph.herokuapp.com and pass in your username to access your graph.
E.g. https://activity-graph.herokuapp.com/graph?username=<your_username>
However, if there are a large number of requests or if the heroku account being used for the project runs out of dyno hours your graph will not load.
- Make a Heroku account.
- Install the Heroku CLI
- Mac:
brew install heroku/brew/heroku
- Ubuntu:
sudo snap install heroku --classic
- Windows: Find the Windows installer here
- Mac:
- Clone the repository:
git clone https://github.com/Ashutosh00710/github-readme-activity-graph.git
- Navigate in to the directory:
cd github-readme-activity-graph
- Login to Heroku:
heroku login
- Create Heroku app:
heroku create
and copy the URL you are given as output. - Deploy app to heroku:
git push heroku main
- Generate personal access token. Copy your token.
- Set token as heroku config var:
heroku config:set TOKEN=<your token goes here>
Now just add the following to your profile readme and you're good to go.
![Github Activity Graph](<url from step 6>/graph?username=<username>)
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
Ashutosh Dwivedi ๐ ๐ป ๐ ๐ค โ |
Kshitij Srivastava ๐ ๐ป ๐ ๐จ |
Thanks goes to these wonderful people (emoji key):
Upamanyu Das ๐ |
Jonah Lawrence ๐ป ๐ |
Milind Modi ๐ |
Vaibhav ๐ป |
This project follows the all-contributors specification. Contributions of any kind welcome!
Purpose | Library Name | Link |
---|---|---|
Graph Construction | CHARTISH.JS | https://github.com/gionkunz/chartist-js |