contributions
A tool allowing you to display or build your merged contributions from different services. Currently supported: Github, Gitlab.
MIT License
Stars
4
Contributions
A tool allowing you to display or build your merged contributions from different services. Currently supported: Github, Gitlab.
Authors
API Reference
Get your contribution data
GET /contributions?github_id=${github_id}&gitlab_id=${gitlab_id}
| Parameter | Type | Description |
|---|---|---|
github_id |
string |
Required. Your github username. |
gitlab_id |
string |
Required. Your gitlab username. |
Get Heatmap from contribution data (returns URL)
GET /contributions/heatmap?github_id=${github_id}&gitlab_id=${gitlab_id}
| Parameter | Type | Description |
|---|---|---|
github_id |
string |
Required. Your github username. |
gitlab_id |
string |
Required. Your gitlab username. |
Environment Variables
To run this project, you will need to add the following environment variables to your .env file
GITHUB_TOKEN: a PAT allowing you to query the Github graphql API. (know more)
PLOTLY_USER: Your plotly username.
PLOTLY_API_KEY: Your own plotly api key. (get it here)
Run Locally
Clone the project
git clone [email protected]:chunk-so/contributions.git
Go to the project directory
cd contributions
Install dependencies
yarn install
Start the server
yarn start