https://github.com/matejmecka/hacktoberfeststats

A NPM Module I built that tells you information about you for your progress during Hacktoberfest.
https://github.com/matejmecka/hacktoberfeststats

github hacktoberfest stats

Last synced: 9 months ago
JSON representation

A NPM Module I built that tells you information about you for your progress during Hacktoberfest.

• Host: GitHub
• URL: https://github.com/matejmecka/hacktoberfeststats
• Owner: MatejMecka
• License: mit
• Created: 2017-10-12T17:14:40.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T18:52:55.000Z (about 3 years ago)
• Last Synced: 2025-04-20T13:19:57.444Z (9 months ago)
• Topics: github, hacktoberfest, stats
• Language: JavaScript
• Homepage:
• Size: 676 KB
• Stars: 16
• Watchers: 1
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# HacktoberfestStats [![npm version](https://badge.fury.io/js/hacktoberfeststats.svg)](https://badge.fury.io/js/hacktoberfeststats)   [ ![License:MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This Module can be used to retrieve all information about a given GitHub user within Hacktoberfest's event.

### Dependencies:

* Request

* Underscore

* Meow

### Installation:

`npm install hacktoberfeststats`

### Usage:

#### CLI

```sh

npx hacktoberfeststats MatejMecka # current year

npx hacktoberfeststats MatejMecka -y 2018

npx hacktoberfeststats MatejMecka --year 2018

```

#### API

```js

const { getHacktoberfestStats } = require('hacktoberfeststats')	

// Using Callbacks

getHacktoberfestStats("MatejMecka", "2018", function(hacktoberfestStats,error){

	if (error) {

		console.log(error.message)

	} else {

		console.log(hacktoberfestStats)

	}

})

// Using Promises

getHacktoberfestStats('MatejMecka', '2018').then(stats => {

    console.log(stats)

})

```

### Options:

The callback function receives an object that contains these properties:

*mainStats*:

* Name: The person’s first name or username

* Completed: Is it Completed or Not. Returns a boolean

* Current: Integer - Number of pull requests

* Progress: How many pull requests a user has made: ex: `11/4`

* Contributions: Repositories where the user did pull requests

* Required: The Number of required pull requests for that year. - Array with URL's linking to Pull Requests