github-contributions-counter

A simple Javascript API that will return the public Github contributions history for a user based on a universal function

!github-contributions-counter

!version

A Quick Note 👀

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.

Getting Started

$3

Via npm

``bash
npm i github-contributions-counter
`

Via yarn

`bash
yarn add github-contributions-counter
`

$3

Demo

Usage

`jsx
import { getGithubContributions } from 'github-contributions-counter'

getGithubContributions({
username: 'github_username',
token: 'github_token' // secret
}).then((r) => {
console.log(r)
})
`

API

$3

| 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 |

Issue Tracker

Issues

Contributing

Contributions are welcomed and encouraged! Refer to Contribution Guidelines

Development

1. Clone

`bash
git clone git@github.com:SammyRobensParadise/github-contributions-counter.git
`

2. Install

`bash
npm install


or


yarn install
`

3. Develop 💻

4. Build using rollup.js

`bash
npm run build


or


yarn run build
``

Info

Author: Sammy Robens-Paradise. sammy.world