{"id":15024669,"url":"https://github.com/johnnythetank/angular-github-api-factory","last_synced_at":"2025-04-12T06:32:12.307Z","repository":{"id":57178462,"uuid":"47684376","full_name":"JohnnyTheTank/angular-github-api-factory","owner":"JohnnyTheTank","description":"AngularJS Factory for GitHub v3 JSON REST API requests","archived":false,"fork":false,"pushed_at":"2018-08-30T15:05:56.000Z","size":17,"stargazers_count":14,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-07T14:47:03.268Z","etag":null,"topics":["angular","angular-factory","angularjs","api","factory","github","github-api"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JohnnyTheTank.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-09T10:24:32.000Z","updated_at":"2023-12-05T15:07:59.000Z","dependencies_parsed_at":"2022-09-09T19:00:12.800Z","dependency_job_id":null,"html_url":"https://github.com/JohnnyTheTank/angular-github-api-factory","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnnyTheTank%2Fangular-github-api-factory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnnyTheTank%2Fangular-github-api-factory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnnyTheTank%2Fangular-github-api-factory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnnyTheTank%2Fangular-github-api-factory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JohnnyTheTank","download_url":"https://codeload.github.com/JohnnyTheTank/angular-github-api-factory/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248529800,"owners_count":21119580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular-factory","angularjs","api","factory","github","github-api"],"created_at":"2024-09-24T20:00:42.997Z","updated_at":"2025-04-12T06:32:11.915Z","avatar_url":"https://github.com/JohnnyTheTank.png","language":"JavaScript","readme":"**angular-github-api-factory** is an angularjs module with a github api factory.\n\n[![npm version](https://badge.fury.io/js/angular-github-api-factory.svg)](https://badge.fury.io/js/angular-github-api-factory)\n[![Bower version](https://badge.fury.io/bo/angular-github-api-factory.svg)](https://badge.fury.io/bo/angular-github-api-factory)\n\nAuthor: Jonathan Hornung ([JohnnyTheTank](https://github.com/JohnnyTheTank))\n\n## Usage\n\n1. Install via either [bower](http://bower.io/), [npm](https://www.npmjs.com/) or downloaded files:\n    1. `bower install --save angular-github-api-factory`\n    2. `npm install --save angular-github-api-factory`\n    3. download [angular-github-api-factory.zip](https://github.com/JohnnyTheTank/angular-github-api-factory/zipball/master)\n\n2. Include dependencies in your HTML.\n    1. When using bower:\n    ```html\n    \u003cscript src=\"bower_components/angular-github-api-factory/dist/angular-github-api-factory.min.js\"\u003e\u003c/script\u003e\n    ```\n    2. When using npm:\n    ```html\n    \u003cscript src=\"node_modules/angular-github-api-factory/dist/angular-github-api-factory.min.js\"\u003e\u003c/script\u003e\n    ```\n    3. when using downloaded files\n    ```html\n    \u003cscript src=\"angular-github-api-factory.min.js\"\u003e\u003c/script\u003e\n    ```\n3. Add **`jtt_github`** to your application's module dependencies.\n4. Use the factory `githubFactory`\n\n### factory methods\n\n#### getUser\n```js\ngithubFactory.getUser({\n    user:\"\u003cUSERNAME_NAME\u003e\",\n    access_token:\"\u003cACCESS_TOKEN\u003e\" // (optional)\n}).then(function(_data){\n    //on success\n}).catch(function (_data) {\n    //on error\n});\n```\n\n#### getUsers\n```js\n// https://developer.github.com/v3/search/#search-users\ngithubFactory.getUsers({\n    q:\"\u003cSEARCH_STRING\u003e\",  // (optional)\n    sort:\"\u003cSORT_STRING\u003e\", // (optional) 'followers', 'repositories', 'joined'\n    order:\"\u003cSORT_ORDER\u003e\", // (optional) 'desc', 'asc'\n    per_page:\"\u003cITEMS_PER_PAGE\u003e\", // (optional) valid values: 1-100 | default: 30\n}).then(function(_data){\n    //on success\n}).catch(function (_data) {\n    //on error\n});\n```\n\n#### getRepo\n```js\ngithubFactory.getRepoByUserAndName({\n    user:\"\u003cUSER_NAME\u003e\",\n    repo:\"\u003cREPO_NAME\u003e\",\n    access_token:\"\u003cACCESS_TOKEN\u003e\" // (optional)\n}).then(function(_data){\n    //on success\n}).catch(function (_data) {\n    //on error\n});\n```\n\n#### getRepos\n```js\n// https://developer.github.com/v3/search/#search-repositories\ngithubFactory.getReposByName({\n    q:\"\u003cSEARCH_STRING\u003e\",\n    sort:\"\u003cSORT_STRING\u003e\", // (optional) 'stars', 'forks', or 'updated'\n    order:\"\u003cSORT_ORDER\u003e\", // (optional) 'desc', 'asc'\n    per_page:\"\u003cITEMS_PER_PAGE\u003e\", // (optional) valid values: 1-100 | default: 30\n    access_token:\"\u003cACCESS_TOKEN\u003e\" // (optional)\n}).then(function(_data){\n    //on success\n}).catch(function (_data) {\n    //on error\n});\n```\n\n```js\ngithubFactory.getReposByUser({\n    user:\"\u003cUSER_NAME\u003e\",\n    q:\"\u003cSEARCH_STRING\u003e\", // (optional)\n    sort:\"\u003cSORT_STRING\u003e\", // (optional) 'stars', 'forks', or 'updated'\n    order:\"\u003cSORT_ORDER\u003e\", // (optional) 'desc', 'asc'\n    per_page:\"\u003cITEMS_PER_PAGE\u003e\", // (optional) valid values: 1-100 | default: 30\n    access_token:\"\u003cACCESS_TOKEN\u003e\" // (optional)\n}).then(function(_data){\n    //on success\n}).catch(function (_data) {\n    //on error\n});\n```\n\n#### getEvents\n```js\ngithubFactory.getEventsFromRepoByUserAndName({\n    user:\"\u003cUSER_NAME\u003e\",\n    repo:\"\u003cREPO_NAME\u003e\",\n    q:\"\u003cSEARCH_STRING\u003e\",  // (optional)\n    sort:\"\u003cSORT_STRING\u003e\", // (optional)\n    order:\"\u003cSORT_ORDER\u003e\", // (optional) 'desc', 'asc'\n    per_page:\"\u003cITEMS_PER_PAGE\u003e\", // (optional) valid values: 1-100 | default: 30\n    access_token:\"\u003cACCESS_TOKEN\u003e\" // (optional)\n}).then(function(_data){\n    //on success\n}).catch(function (_data) {\n    //on error\n});\n```\n\n```js\ngithubFactory.getEventsByUser({\n    user:\"\u003cUSER_NAME\u003e\",\n    q:\"\u003cSEARCH_STRING\u003e\", // (optional)\n    sort:\"\u003cSORT_STRING\u003e\", // (optional)\n    order:\"\u003cSORT_ORDER\u003e\", // (optional) 'desc', 'asc'\n    per_page:\"\u003cITEMS_PER_PAGE\u003e\", // (optional) valid values: 1-100 | default: 30\n    access_token:\"\u003cACCESS_TOKEN\u003e\" // (optional)\n}).then(function(_data){\n    //on success\n}).catch(function (_data) {\n    //on error\n});\n```\n\n\n## Github JSON API\n\n* docs: https://developer.github.com/v3/\n\n## More angular-api-factories\n[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)\n\n## License\n\nMIT","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnnythetank%2Fangular-github-api-factory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnnythetank%2Fangular-github-api-factory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnnythetank%2Fangular-github-api-factory/lists"}