https://github.com/akshaykumar6/github-js
Javascript Plugin over Github APIs.
https://github.com/akshaykumar6/github-js
github-js github-widget javascript javascript-plugin
Last synced: 15 days ago
JSON representation
Javascript Plugin over Github APIs.
- Host: GitHub
- URL: https://github.com/akshaykumar6/github-js
- Owner: akshaykumar6
- License: mit
- Created: 2015-03-08T05:11:07.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2019-10-26T17:16:06.000Z (over 6 years ago)
- Last Synced: 2026-01-23T09:59:10.448Z (about 1 month ago)
- Topics: github-js, github-widget, javascript, javascript-plugin
- Language: JavaScript
- Homepage: https://akshaykumar6.github.io/github-js
- Size: 450 KB
- Stars: 193
- Watchers: 10
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github.js
Github.js is a JavaScript plugin over [GitHub APIs v3](https://developer.github.com/v3/). It gives an easy way to feature your GitHub open-source contributions on your website or portfolio.
# Demo
[Click here](http://akshaykumar6.github.io/github-js) for live examples.
#Dependency
The plugin has hard dependency on [underscore.js](http://underscorejs.org/)(~v1.6.0). You can download it from [here](https://github.com/jashkenas/underscore/archive/1.6.0.zip).
# Installation
Add **github.js** and **github.css** to your project. [Download v0.1.3](https://github.com/akshaykumar6/github-js/archive/v0.1.3.zip).
```html
// Add underscore.js
```
Github.js is available via [bower](http://bower.io/search/?q=githubjs) and [npm](https://www.npmjs.com/package/githubjs).
```
$ bower install --save githubjs
$ npm install --save githubjs
```
# Usage
### User Profile
```javascript
Github.userProfile({
username: "jashkenas",
selector: ".user-1"
});
```
### User Activity
```javascript
Github.userActivity({
username: "torvalds",
selector: ".user-2"
});
```
### Repository Profile
```javascript
Github.repoProfile({
username: 'atom',
reponame: 'atom',
selector: '.repo-1'
});
```
### Repository Activity
```javascript
Github.repoActivity({
username: 'joyent',
reponame: 'node',
selector: '.repo-2'
});
```
### Organization Profile
```javascript
Github.orgProfile({
orgname: 'facebook',
selector: '.org-1'
});
```
### Organization Activity
```javascript
Github.orgActivity({
orgname: 'google',
selector: '.org-2'
});
```
# Documentation
* [Complete Documentation](https://github.com/akshaykumar6/github-js/wiki)
* [Annotated Source Code](http://akshaykumar6.github.io/github-js/docs/github.html)
# Contribute
To start contributing to Github.js, clone the repository and start playing.
```
$ git clone git@github.com:akshaykumar6/github-js.git
$ cd github-js
```
If you're not familiar with Git, visit the [Git homepage](http://git-scm.com/) to download Git for your platform.
**Got a bug or a feature request?** [Please open a new issue](https://github.com/akshaykumar6/github-js/issues).
# License
**github-js** © 2015, Akshay Sharma Released under the [MIT License](http://mit-license.org/).
Authored and maintained by [Akshay Sharma](http://akshaykumar6.github.io/).