A widget for displaying GitHub activity for a user.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Fix invalid pull request review comment link resolving #29 Aug 12, 2017
.gitignore Remove dist files from repository. Resolves #20. Oct 27, 2015
Gruntfile.js
LICENSE.md Update year to 2015 (a little late on this one) Oct 7, 2015
README.md Bump version to 0.1.5 Aug 12, 2017
bower.json Bump version to 0.1.5 Aug 12, 2017
package.json Bump version to 0.1.5 Aug 12, 2017

README.md

GitHub Activity Stream Widget

This is a small Javascript plugin that creates a stream of your recent GitHub activity. It displays the user's name, username, photo, and a list of each individual activity type. Click here for a demo.

A sample image of the activity stream is shown below:

Dependencies

The two dependencies for the plugin are the Mustache templating library and Octicons (if you want the icons to show). You can include these along with the scripts for the plugin in the head of your page with the following HTML:

<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/octicons/2.0.2/octicons.min.css">
<link rel="stylesheet" href="github-activity-0.1.5.min.css">

<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/mustache.js/0.7.2/mustache.min.js"></script>
<script type="text/javascript" src="github-activity-0.1.5.min.js"></script>

The files can be downloaded from the releases page.

If you'd like to build the files yourself:

# Ensure you have grunt and bower installed
npm install bower
npm install grunt-cli

# Clone the repository
git clone https://github.com/caseyscarborough/github-activity.git
cd github-activity

# Install dependencies
bower install

# Build dist
grunt

Usage

To use the library, begin by creating a new div with an id in the body of your page:

<div id="feed"></div>

Then call the feed method via Javascript:

GitHubActivity.feed({
	username: "your-username",
	repository: "your-repo", // optional
	selector: "#feed",
	limit: 20 // optional
});

Credits

Fork and Enjoy

Please feel free to contribute to the application by following the steps below:

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request