Repository files navigation

Apply within

Github.js provides a minimal higher-level wrapper around Github's API.

/*   Data can be retrieved from the API either using callbacks (as in versions < 1.0)   or using a new promise-based API. The promise-based API returns the raw Axios   request promise. */importGitHubfrom'github-api';// unauthenticated clientconstgh=newGitHub();letgist=gh.getGist();// not a gist yetgist.create({public:true,description:'My first gist',files:{"file1.txt":{content:"Aren't gists great!"}}}).then(function({data}){// Promises!letcreatedGist=data;returngist.read();}).then(function({data}){letretrievedGist=data;// do interesting things});

varGitHub=require('github-api');// basic authvargh=newGitHub({username:'FOO',password:'NotFoo'/* also acceptable:      token: 'MY_OAUTH_TOKEN'    */});varme=gh.getUser();// no user specified defaults to the user for whom credentials were providedme.listNotifications(function(err,notifications){// do some stuff});varclayreimann=gh.getUser('clayreimann');clayreimann.listStarredRepos(function(err,repos){// look at all the starred repos!});

API documentation is hosted on github pages, and is generated from JSDoc; any contributionsshould include updated JSDoc.

Github.js is available fromnpm orunpkg.

npm install github-api

<!-- just github-api source (5.3kb) --><scriptsrc="https://unpkg.com/github-api/dist/GitHub.min.js"></script><!-- standalone (20.3kb) --><scriptsrc="https://unpkg.com/github-api/dist/GitHub.bundle.min.js"></script>

Github.js is tested on node's LTS and current versions.

We welcome contributions of all types! This section will guide you through setting up your development environment.

1. Install Node version 8,10 or 11. It can often help to use a Node version switcher such asNVM.
2. Fork this repo to your GitHub account.
3. Clone the fork to your development machine (git clone https://github.com/{YOUR_USERNAME}/github).
4. From the root of the cloned repo, runnpm install.
5. Emailjaredrewerts@gmail.com with the subjectGitHub API - Personal Access Token Request

A personal access token for our test user, @github-tools-test, will be generated for you.

6. Set the environment variableGHTOOLS_USER togithub-tools-test.

export GHTOOLS_USER=github-tools-test

7. Set the environment variableGHTOOLS_PASSWORD to the personal access token that was generated for you.

export GHTOOLS_PASSWORD={YOUR_PAT}

NOTE Windows users can usethis guide to learn about setting environment variables on Windows.

The main way we write code forgithub-api is using test-driven development. We use Mocha to run our tests. Given that the bulk of this library is just interacting with GitHub's API, nearly all of our tests are integration tests.

To run the test suite, runnpm run test.