JSPM

githubtopcontributors

0.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q28905F
  • License MIT

node.js module to query the GitHub API and get the "top 10" contributors

Package Exports

  • githubtopcontributors

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (githubtopcontributors) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

githubtopcontributors

Node.js site using the githubtopcontributors_module that queries the GitHub API, retrieves the "top 10" contributors, and displays the results with an ngGrid using angularJS.

Installation

This project is available on GitHub.

Usage

To start, download the source from GitHub. Navigate to the project folder and run npm install to install the project's dependencies.

Then run the following command:

npm start

and from there navigate to http://localhost:3001/.

You'll need to login with your github credentials via oauth before accessing the API and main access page.

Once you're authenticated, to access the top 10 contributors to a repository, enter the path of the repository e.g. /repos/stanleyta/githubtopcontributors/contributors, click 'Go', and voila. The ngGrid should populate with the top 10 contributors sorted by rank.

Once the table has been loaded, you can sort the table however you wish.

Running Tests

Install mocha globally. Then run the following command:

npm install -g mocha

Then simply run the tests.

npm test

License

Licensed under MIT.