Gh-repos NPM | npm.io

gh-repos

Get one or all the owner repositories from GitHub.

:cloud: Installation

# Using npm
npm install --save gh-repos

# Using yarn
yarn add gh-repos

:clipboard: Example

const githubRepos = require("gh-repos");

// Get a specific repository (the result will be an array containing one element)
githubRepos("IonicaBizau/git-stats", function (err, repos) {
    console.log(err || repos);
    // [ { id: 30538630,
    //     name: 'git-stats',
    //     full_name: 'IonicaBizau/git-stats',
    //     owner: { login: 'IonicaBizau', ...},
    //     private: false,
    //     ...
    //     subscribers_count: 52 } ]
});

// Get all my repositories
githubRepos("IonicaBizau", function (err, repos) {
    console.log(err || repos);
    // [ { id: 20149013,
    //     name: '3x3-equation-solver',
    //     full_name: 'IonicaBizau/3x3-equation-solver',
    //     owner: {...},
    //     ...
    //     default_branch: 'master' },
    //   { id: 48318047,
    //     name: 'add-subtract-date',
    //     full_name: 'IonicaBizau/add-subtract-date',
    //     owner: {...},
    //     ...
    //     default_branch: 'master' },
    //   ...
    //   { id: 21358670,
    //     name: 'youtube-topmost',
    //     full_name: 'IonicaBizau/youtube-topmost',
    //     owner: {...},
    //     ...
    //     default_branch: 'master' } ]
});

// Use a token
githubRepos("IonicaBizau", "your token", function (err, repos) {
    // ...
});

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`ghRepos(input, token, cb)`

Get one or all the owner repositories from GitHub.

Params

String input: The GitHub owner or repository full name (owner/repo).
String token: An optional GitHub token.
Function cb: The callback function.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6