Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mpellouin/contributions
A tool allowing you to display or build your merged contributions from different services. Currently supported: Github, Gitlab.
https://github.com/mpellouin/contributions
contributions contributions-graph github gitlab heatmap nestjs plotly
Last synced: 2 months ago
JSON representation
A tool allowing you to display or build your merged contributions from different services. Currently supported: Github, Gitlab.
- Host: GitHub
- URL: https://github.com/mpellouin/contributions
- Owner: mpellouin
- License: mit
- Created: 2024-05-01T04:07:08.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-02T00:34:38.000Z (7 months ago)
- Last Synced: 2024-06-02T01:41:45.693Z (7 months ago)
- Topics: contributions, contributions-graph, github, gitlab, heatmap, nestjs, plotly
- Language: TypeScript
- Homepage:
- Size: 741 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Contributions
A tool allowing you to display or build your merged contributions from different services. Currently supported: Github, Gitlab.
## Authors
- [@mpellouin](https://www.github.com/mpellouin)
## API Reference
#### Get your contribution data
```http
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)
```http
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](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens))
`PLOTLY_USER`: Your plotly username.
`PLOTLY_API_KEY`: Your own plotly api key. ([get it here](https://chart-studio.plotly.com/settings/api#/))
## Run Locally
Clone the project
```bash
git clone [email protected]:chunk-so/contributions.git
```
Go to the project directory
```bash
cd contributions
```
Install dependencies
```bash
yarn install
```
Start the server
```bash
yarn start
```
## License
[MIT](https://choosealicense.com/licenses/mit/)