{"id":15055470,"url":"https://github.com/mpellouin/contributions","last_synced_at":"2025-04-10T03:41:21.459Z","repository":{"id":237371278,"uuid":"794397156","full_name":"mpellouin/contributions","owner":"mpellouin","description":"A tool allowing you to display or build your merged contributions from different services. Currently supported: Github, Gitlab.","archived":false,"fork":false,"pushed_at":"2024-06-02T00:34:38.000Z","size":759,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-06-02T01:41:45.693Z","etag":null,"topics":["contributions","contributions-graph","github","gitlab","heatmap","nestjs","plotly"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mpellouin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"mpellouin","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":null}},"created_at":"2024-05-01T04:07:08.000Z","updated_at":"2024-06-02T01:41:48.672Z","dependencies_parsed_at":"2024-05-21T01:41:29.597Z","dependency_job_id":"a66e2fea-a19d-41b3-8b33-cd75a94750b3","html_url":"https://github.com/mpellouin/contributions","commit_stats":null,"previous_names":["chunk-so/contributions","mpellouin/contributions"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpellouin%2Fcontributions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpellouin%2Fcontributions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpellouin%2Fcontributions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpellouin%2Fcontributions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mpellouin","download_url":"https://codeload.github.com/mpellouin/contributions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248154963,"owners_count":21056541,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["contributions","contributions-graph","github","gitlab","heatmap","nestjs","plotly"],"created_at":"2024-09-24T21:42:28.504Z","updated_at":"2025-04-10T03:41:21.445Z","avatar_url":"https://github.com/mpellouin.png","language":"TypeScript","funding_links":["https://ko-fi.com/mpellouin"],"categories":[],"sub_categories":[],"readme":"\n# Contributions\n\nA tool allowing you to display or build your merged contributions from different services. Currently supported: Github, Gitlab.\n\n![/assets/README_image.jpg](/assets/README_image.jpg)\n\n\n## Authors\n\n- [@mpellouin](https://www.github.com/mpellouin)\n\n\n## API Reference\n\n#### Get your contribution data\n\n```http\n  GET /contributions?github_id=${github_id}\u0026gitlab_id=${gitlab_id}\n```\n\n| Parameter   | Type     | Description                         |\n| :---------- | :------- | :---------------------------------- |\n| `github_id` | `string` | **Required**. Your github username. |\n| `gitlab_id` | `string` | **Required**. Your gitlab username. |\n\n#### Get Heatmap from contribution data (returns URL)\n\n```http\n  GET /contributions/heatmap?github_id=${github_id}\u0026gitlab_id=${gitlab_id}\n```\n\n| Parameter   | Type     | Description                         |\n| :---------- | :------- | :---------------------------------- |\n| `github_id` | `string` | **Required**. Your github username. |\n| `gitlab_id` | `string` | **Required**. Your gitlab username. |\n\n\n\n## Environment Variables\n\nTo run this project, you will need to add the following environment variables to your .env file\n\n`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))\n\n`PLOTLY_USER`: Your plotly username.\n\n`PLOTLY_API_KEY`: Your own plotly api key. ([get it here](https://chart-studio.plotly.com/settings/api#/))\n\n\n## Run Locally\n\nClone the project\n\n```bash\n  git clone git@github.com:chunk-so/contributions.git\n```\n\nGo to the project directory\n\n```bash\n  cd contributions\n```\n\nInstall dependencies\n\n```bash\n  yarn install\n```\n\nStart the server\n\n```bash\n  yarn start\n```\n\n## Known issues\n\nPlotly free plan includes 100 plot generation. Therefore if you use the github action and have a free plan on plotly, the action will stop working the 100th day.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmpellouin%2Fcontributions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmpellouin%2Fcontributions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmpellouin%2Fcontributions/lists"}