Skip to content

Frontend JavaScript library for interacting with the GitHub API v3

Notifications You must be signed in to change notification settings

Olical/github.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

github.js

Frontend JavaScript library for interacting with the GitHub API v3.

Dependencies

There are no dependencies in the front end. You must have node.js, UglifyJS and make to build the code. You can build the code by runnin make from your terminal.

API support

My aim is to cover the whole API. This is the current status.

  • full - Gists
  • partial - Git data
  • none - Issues
  • none - Organisations
  • none - Pull requests
  • none - Repositories
  • none - Users
  • none - Events

Testing

The tests are pretty heavy. They should be run from inside the Chrome app or similar method to allow XHR. Please create ./test/auth.js containing your GitHub login details before running. It should look like this.

var user = 'USERNAME',
	password = 'PASSWORD';

When you are all set up, just load ./test/index.html to run the automated tests.

Testing is currently only performed in modern browsers such as Google Chrome and Firefox. Older browser support will come later.

Licence

Creative Commons License
github.js by Oliver Caldwell is licensed under a Creative Commons Attribution 3.0 Unported License.

About

Frontend JavaScript library for interacting with the GitHub API v3

Resources

Stars

Watchers

Forks

Packages