Github Readme Activity Graph

A dynamically generated activity graph to show your GitHub activities of last 31 days.

Table of contents

• Table of contents
• How to Use
  • Attention ⚠
• Use themes
• Available Themes
• Customization
  • Common Options
• Deploy on your own Heroku instance
  • Step-by-step instructions for deploying to Heroku (from UI)
  • Step-by-step instructions for deploying to Heroku (from CLI)
• Contributing
• Core Team 💻
• Contributors ✨
• Resources Used to build this project
  • Made with ❤ and TypeScript

How to Use

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)

Attention ⚠

Use themes

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

Available Themes

Name	Preview
Default (cotton candy)
react-dark
github
xcode
rogue

For more themes click here

Customization

Customize the appearance of your Activity Graph however you want with URL params.

Common Options

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_color	color of the area under the 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)
hide_title	sets the title to an empty string	boolean (default: false)
custom_title	set the title to any string	string
theme	name of available themes	string

⚠ For custom_title please make sure you are use %20 for spaces

Example:

custom_title=This%20is%20a%20title

[![Ashutosh's github activity graph](https://activity-graph.herokuapp.com/graph?username=ashutosh00710&custom_title=This%20is%20a%20title&hide_border=true)](https://github.com/ashutosh00710/github-readme-activity-graph)

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)

Deploy on your own Heroku instance

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.

Step-by-step instructions for deploying to Heroku (from UI)

1. Sign in to Heroku or create a new account at https://heroku.com
2. Click the Deploy button below

3. On the page that comes up, click "Deploy App" at the end of the form
4. Once the app is deployed, click "Manage App" to go to the dashboard
5. Visit the "Settings" tab and click "Reveal Config Vars"
6. Visit this link to create a new Personal Access Token
7. Scroll to the bottom and click "Generate token"
8. Add the token as a Config Var with the key TOKEN

9. Scroll down to the Domains section to find the URL you will use in place of activity-graph.herokuapp.com

Step-by-step instructions for deploying to Heroku (from CLI)

1. Make a Heroku account.
2. Install the Heroku CLI
   • Mac: brew install heroku/brew/heroku
   • Ubuntu: sudo snap install heroku --classic
   • Windows: Find the Windows installer here
3. Clone the repository: git clone https://github.com/Ashutosh00710/github-readme-activity-graph.git
4. Navigate in to the directory: cd github-readme-activity-graph
5. Login to Heroku: heroku login
6. Create Heroku app: heroku create and copy the URL you are given as output.
7. Deploy app to heroku: git push heroku main
8. Generate personal access token. Copy your token.
9. 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>)

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Core Team 💻

Ashutosh Dwivedi 📆 💻 📖 🤔 ⚠

Kshitij Srivastava 📆 💻 📖 🎨

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Upamanyu Das 📖

Jonah Lawrence 💻 📖

Milind Modi 📖

Vaibhav 💻 📖

Jacob Philpott 💻 📖

Sonu Kumar 🎨 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Resources Used to build this project

Purpose	Library Name	Link
Graph Construction	CHARTIST.JS	https://github.com/gionkunz/chartist-js

---

Made with ❤ and TypeScript