Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ashutosh00710/github-readme-activity-graph

A dynamically generated activity graph to show your GitHub activities of last 31 days.
https://github.com/ashutosh00710/github-readme-activity-graph

contribution dynamic github-activity graph hacktoberfest hacktoberfest2021 readme statistics

Last synced: 2 days ago
JSON representation

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

Awesome Lists containing this project

README

        



Github Readme Activity Graph






Supported by JetBrains


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

### ⚠️ NOTICE: DEPLOYMENT MOVED ⚠️

The deployment of this project is moved from `https://activity-graph.herokuapp.com` domain to `https://github-readme-activity-graph.cyclic.app`. In case `https://github-readme-activity-graph.cyclic.app` doesn't work try with `https://github-readme-activity-graph.vercel.app` for more details, refer [this](https://github.com/Ashutosh00710/github-readme-activity-graph/issues/197#issuecomment-1560633754)

Please refer to the updated link [here](#how-to-use)

## Table of contents

- [Table of contents](#table-of-contents)
- [How to Use](#how-to-use)
- [Attention ⚠](#attention-)
- [Use themes](#use-themes)
- [Available Themes](#available-themes)
- [Customization](#customization)
- [Common Options](#common-options)
- [Deploy on your own Replit instance](#deploy-on-your-own-replit-instance)
- [Follow the steps](#follow-the-steps)
- [Deploy on your own Vercel instance](#deploy-on-your-own-vercel-instance)
- [First Method](#first-method)
- [Second Method](#second-method)
- [Finally](#finally)
- [Contributing](#contributing)
- [Core Team 💻](#core-team-)
- [Contributors ✨](#contributors-)
- [Resources Used to build this project](#resources-used-to-build-this-project)
- [Star History](#star-history)
- [Made with ❤ and TypeScript ](#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**

```md
[![Ashutosh's github activity graph](https://github-readme-activity-graph.vercel.app/graph?username=Ashutosh00710)](https://github.com/ashutosh00710/github-readme-activity-graph)
```

### [Attention ⚠](#Deploy-on-your-own-heroku-instance)

## Use themes

_`username=ashutosh00710&theme=theme_name`_

```md
[![Ashutosh's github activity graph](https://github-readme-activity-graph.vercel.app/graph?username=Ashutosh00710&theme=dracula)](https://github.com/ashutosh00710/github-readme-activity-graph)
```

[Manual Customization](#customization) is also available

## Available Themes

| Name | Preview |
| :------------------------: | :------------------------------------------------------------: |
| **Default (cotton candy)** | graph |
| **react** | graph |
| **react-dark** | graph |
| **github** | graph |
| **github-compact** | graph |
| **xcode** | graph |
| **rogue** | graph |
| **merko** | graph |
| **vue** | graph |
| **tokyo-night** | graph |
| **high-contrast** | graph |

For more themes click [here](https://github.com/Ashutosh00710/github-readme-activity-graph/blob/main/THEMES.md)

## 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 `#`) |
| `title_color` | graph card's title 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](#available-themes) | string |
| `radius` | border radius of graph | number (0-16 inclusive) |
| `height` | height of the graph | number (200-600 inclusive) |
| `days` | number of to days display on graph | number between (1 - 90) [Recommended below 40] |
| `from` | date from which the graph starts | format `YYYY-MM-DD` |
| `to` | date where the graph will end | format `YYYY-MM-DD` |
| `grid` | show grid | boolean (default: `true`) |

⚠ **For `custom_title` please make sure that you are using %20 for spaces**

Example:

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

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

**Example:**

```md
[![Ashutosh's github activity graph](https://github-readme-activity-graph.vercel.app/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 Replit instance

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

#### Follow the steps

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


Run on Repl.it

3. On the page that comes up, choose language as `Node.js` and then click `Import from GitHub` Button

![Replit](./asset/replit1.png)

4. Visit [this link](https://github.com/settings/tokens/new?description=GitHub%20Readme%20Activity%20Graph) to create a new Personal Access Token
5. Scroll to the bottom and click "**Generate token**"
6. Wait clone done and add `Secrets` with your `Github token`

![Secrets](./asset/replit2.png)

7. Click the green `RUN` button on top, the console will run and at last the url will shows on the right
8. Now just add the following to your profile readme and you're good to go

```
![Github Activity Graph](/graph?username=)
```

## Deploy on your own Vercel instance

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

#### First Method

1. Go to [vercel.com](https://vercel.com/).
2. Click on `Log in`.
![image](https://user-images.githubusercontent.com/3431285/235332307-a98adccf-ac8e-4c05-8fae-b14e7d0b81e8.png)
3. Sign in with GitHub by pressing `Continue with GitHub`.
![image](https://user-images.githubusercontent.com/3431285/235332299-70f52a0f-ffb9-4070-ae85-a4646a2bb1bf.png)
4. Sign in to GitHub and allow access to all repositories if prompted.
5. Fork this repo.
6. Go back to your [Vercel dashboard](https://vercel.com/dashboard).
7. To import a project, click the `Add New...` button and select the `Project` option.
![image](https://user-images.githubusercontent.com/3431285/235332320-d80e62c9-a7d9-45f3-8bef-b8950c4c9093.png)
8. Click the `Continue with GitHub` button, search for the required Git Repository and import it by clicking the `Import` button.
![image](https://user-images.githubusercontent.com/3431285/235332373-3f28309c-d70b-490e-aa40-4d55ad429d5a.png)
9. Create a personal access token (PAT) [here](https://github.com/settings/tokens/new) and enable the `repo` permissions (this allows access to see private repo stats).
![image](https://user-images.githubusercontent.com/3431285/235332420-df83a424-009b-4f69-bbb2-54e807bff701.png)
10. Add the PAT as an environment variable named `TOKEN`.
![image](https://user-images.githubusercontent.com/3431285/235332471-6915abf8-04fe-4f5e-b734-191388a77140.png)
11. Click deploy, and you're good to go. See your domains to use the API!

#### Second Method

Alternatively, click the button below and follow the instructions.

[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/Ashutosh00710/github-readme-activity-graph)

After the deployment is complete:

1. Click the `Continue to Dashboard` button
![image](https://user-images.githubusercontent.com/3431285/235332677-addafd5f-dce8-4823-9927-05657eec2084.png)
2. In the `Settings` tab, click on `Environment Variables` and follow steps `9.` and `10.` of `First Method`.
![image](https://user-images.githubusercontent.com/3431285/235332731-03207969-b16e-42e4-858a-67b05af7bcc8.png)
3. Go to `Deployments` tab and redeploy the project.
![image](https://user-images.githubusercontent.com/3431285/235332761-1d3ae9c5-0138-447f-a41a-601c73ef3104.png)

#### Finally

Now just add the following to your profile readme and you're good to go.

```md
![Github Activity Graph](<{your_own_domain_name}.vercel.app>/graph?username=)
```

## Contributing

Please read through our [contributing guidelines](https://github.com/Ashutosh00710/github-readme-activity-graph/blob/main/CONTRIBUTING.md). Directions are included for opening issues, coding standards, and notes on development.

## Core Team 💻







Ashutosh Dwivedi



📆
💻
📖
🤔







Kshitij Srivastava



📆
💻
📖
🎨

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):







Upamanyu Das



📖






Jonah Lawrence



💻
📖






Milind Modi



📖






Vaibhav



💻
📖






Jacob Philpott



💻
📖






Sonu Kumar



🎨
📖






Mykola Symon



💻








Sreyan Ghosh



🎨






Anant Mishra



🎨






Skyler



🎨






Iryna Mykoliuk



🎨






Dalpat Rathore



🎨
💻






Dmitriy Fishman



📖






MagicLike



🎨
💻








OnkarRuikar



💻






valetzx



📖






tranthaituananh



🎨
📖






polekstulod



📖






jmloudis



💻






fabianocouto



💻
📖

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Resources Used to build this project

| Purpose | Library Name | Link |
| :----------------: | :-------------: | :---------------------------------------: |
| Graph Construction | **CHARTIST.JS** | |


## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=Ashutosh00710/github-readme-activity-graph&type=Timeline)](https://star-history.com/#Ashutosh00710/github-readme-activity-graph&Timeline)

### Made with ❤ and TypeScript