Github.js
Github.js provides a minimal higher-level wrapper around Github's API. It was concieved in the context of
Prose, a content editor for GitHub.
Installation
Github.js is available from npm
or npmcdn.
npm install github-api
<script src="//npmcdn.com/github-api/dist/GitHub.min.js"></script>
<script src="//npmcdn.com/github-api/dist/GitHub.bundle.min.js"></script>
## Compatibility
Github.js is tested on Node:
GitHub Tools
The team behind Github.js has created a whole organization, called GitHub Tools,
dedicated to GitHub and its API. In the near future this repository could be moved under the GitHub Tools organization
as well. In the meantime, we recommend you to take a look at other projects of the organization.
Samples
import GitHub from 'github-api';
const gh = new GitHub();
let gist = gh.getGist();
gist.create({
public: true,
description: 'My first gist',
files: {
"file1.txt": {
contents: "Aren't gists great!"
}
}
}).then(function({data}) {
let gistJson = data;
gist.read(function(err, gist, xhr) {
});
});
import GitHub from 'github-api';
const gh = new GitHub({
username: 'FOO',
password: 'NotFoo'
});
const me = gh.getUser();
me.listNotifications(function(err, notifcations) {
});
const clayreimann = gh.getUser('clayreimann');
clayreimann.getStarredRepos()
.then(function({data: reposJson}) {
});
var GitHub = require('github-api');
var gh = new GitHub({
token: 'MY_OAUTH_TOKEN'
});
var yahoo = gh.getOrganization('yahoo');
yahoo.getRepos(function(err, repos) {
})