https://github.com/olical/github.js
Frontend JavaScript library for interacting with the GitHub API v3
https://github.com/olical/github.js
Last synced: 8 months ago
JSON representation
Frontend JavaScript library for interacting with the GitHub API v3
- Host: GitHub
- URL: https://github.com/olical/github.js
- Owner: Olical
- Created: 2012-01-15T12:51:05.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2012-01-23T14:38:19.000Z (almost 14 years ago)
- Last Synced: 2025-04-01T10:42:38.181Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 166 KB
- Stars: 14
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](http://nodejs.org/), [UglifyJS](https://github.com/mishoo/UglifyJS) and [make](http://www.gnu.org/software/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
github.js by Oliver Caldwell is licensed under a Creative Commons Attribution 3.0 Unported License.