github-contributions-counter

    2.1.4 • Public • Published

    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

    Install

    Via npm

    npm i github-contributions-counter

    Via yarn

    yarn add github-contributions-counter

    Demo

    Demo

    Usage

    import { getGithubContributions } from 'github-contributions-counter'
    
    getGithubContributions({
      username: 'github_username',
      token: 'github_token' // secret
    }).then((r) => {
      console.log(r)
    })

    API

    Interface

    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
    git clone git@github.com:SammyRobensParadise/github-contributions-counter.git
    1. Install
    npm install
    # or
    yarn install
    1. Develop 💻

    2. Build using rollup.js

    npm run build
    # or
    yarn run build

    Info

    Author: Sammy Robens-Paradise. sammy.world

    Install

    npm i github-contributions-counter

    DownloadsWeekly Downloads

    10

    Version

    2.1.4

    License

    MIT

    Unpacked Size

    633 kB

    Total Files

    27

    Last publish

    Collaborators

    • sammyrp