Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnnythetank/angular-github-api-factory
AngularJS Factory for GitHub v3 JSON REST API requests
https://github.com/johnnythetank/angular-github-api-factory
angular angular-factory angularjs api factory github github-api
Last synced: about 2 months ago
JSON representation
AngularJS Factory for GitHub v3 JSON REST API requests
- Host: GitHub
- URL: https://github.com/johnnythetank/angular-github-api-factory
- Owner: JohnnyTheTank
- License: mit
- Created: 2015-12-09T10:24:32.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-08-30T15:05:56.000Z (over 6 years ago)
- Last Synced: 2024-11-07T11:04:24.199Z (about 2 months ago)
- Topics: angular, angular-factory, angularjs, api, factory, github, github-api
- Language: JavaScript
- Size: 16.6 KB
- Stars: 14
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**angular-github-api-factory** is an angularjs module with a github api factory.
[](https://badge.fury.io/js/angular-github-api-factory)
[](https://badge.fury.io/bo/angular-github-api-factory)
Author: Jonathan Hornung ([JohnnyTheTank](https://github.com/JohnnyTheTank))
## Usage
1. Install via either [bower](http://bower.io/), [npm](https://www.npmjs.com/) or downloaded files:
1. `bower install --save angular-github-api-factory`
2. `npm install --save angular-github-api-factory`
3. download [angular-github-api-factory.zip](https://github.com/JohnnyTheTank/angular-github-api-factory/zipball/master)
2. Include dependencies in your HTML.
1. When using bower:
```html
```
2. When using npm:
```html
```
3. when using downloaded files
```html
```
3. Add **`jtt_github`** to your application's module dependencies.
4. Use the factory `githubFactory`
### factory methods
#### getUser
```js
githubFactory.getUser({
user:"",
access_token:"" // (optional)
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### getUsers
```js
// https://developer.github.com/v3/search/#search-users
githubFactory.getUsers({
q:"", // (optional)
sort:"", // (optional) 'followers', 'repositories', 'joined'
order:"", // (optional) 'desc', 'asc'
per_page:"", // (optional) valid values: 1-100 | default: 30
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### getRepo
```js
githubFactory.getRepoByUserAndName({
user:"",
repo:"",
access_token:"" // (optional)
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### getRepos
```js
// https://developer.github.com/v3/search/#search-repositories
githubFactory.getReposByName({
q:"",
sort:"", // (optional) 'stars', 'forks', or 'updated'
order:"", // (optional) 'desc', 'asc'
per_page:"", // (optional) valid values: 1-100 | default: 30
access_token:"" // (optional)
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
```js
githubFactory.getReposByUser({
user:"",
q:"", // (optional)
sort:"", // (optional) 'stars', 'forks', or 'updated'
order:"", // (optional) 'desc', 'asc'
per_page:"", // (optional) valid values: 1-100 | default: 30
access_token:"" // (optional)
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
#### getEvents
```js
githubFactory.getEventsFromRepoByUserAndName({
user:"",
repo:"",
q:"", // (optional)
sort:"", // (optional)
order:"", // (optional) 'desc', 'asc'
per_page:"", // (optional) valid values: 1-100 | default: 30
access_token:"" // (optional)
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
```js
githubFactory.getEventsByUser({
user:"",
q:"", // (optional)
sort:"", // (optional)
order:"", // (optional) 'desc', 'asc'
per_page:"", // (optional) valid values: 1-100 | default: 30
access_token:"" // (optional)
}).then(function(_data){
//on success
}).catch(function (_data) {
//on error
});
```
## Github JSON API
* docs: https://developer.github.com/v3/
## More angular-api-factories
[bandsintown](https://github.com/JohnnyTheTank/angular-bandsintown-api-factory) - [dailymotion](https://github.com/JohnnyTheTank/angular-dailymotion-api-factory) - [facebook](https://github.com/JohnnyTheTank/angular-facebook-api-factory) - [footballdata](https://github.com/JohnnyTheTank/angular-footballdata-api-factory) - [flickr](https://github.com/JohnnyTheTank/angular-flickr-api-factory) - **github** - [openweathermap](https://github.com/JohnnyTheTank/angular-openweathermap-api-factory) - [tumblr](https://github.com/JohnnyTheTank/angular-tumblr-api-factory) - [vimeo](https://github.com/JohnnyTheTank/angular-vimeo-api-factory) - [wikipedia](https://github.com/JohnnyTheTank/angular-wikipedia-api-factory) - [youtube](https://github.com/JohnnyTheTank/angular-youtube-api-factory)
## License
MIT