A simple Javascript API that will return the public github contributions history for a user based on a universal function
npm install github-contributions-counterA simple Javascript API that will return the public Github contributions history for a user based on a universal function
This is a simple REST API wrapper around GitHubs API/V4 contributions graphQL api. Prior to the implementation of the V4 api this package scraped contribution data from GitHub profiles.
Via npm
``bash`
npm i github-contributions-counter
Via yarn
`bash`
yarn add github-contributions-counter
`jsx
import { getGithubContributions } from 'github-contributions-counter'
getGithubContributions({
username: 'github_username',
token: 'github_token' // secret
}).then((r) => {
console.log(r)
})
`
| Parameter | Description | Status | Type |
| --- | --- | --- | --- |
| username | A valid GitHub username. Organization names are not currently supported | Required | string |token
| | A valid GitHub PAT with read:usr permissions. You can find instructions on how to generate a PAT here. | Required | string |
Contributions are welcomed and encouraged! Refer to Contribution Guidelines
1. Clone
`bash`
git clone git@github.com:SammyRobensParadise/github-contributions-counter.git
2. Install
`bash`
npm installor
yarn install
3. Develop 💻
4. Build using rollup.js
`bash``
npm run buildor
yarn run build
Author: Sammy Robens-Paradise. sammy.world