jQuery plugin to display your GitHub projects and Coderwall badges
CoffeeScript
Pull request Compare This branch is 22 commits behind icebreaker:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
src
.gitignore
LICENSE
README.md
jquery-proudify.js
jquery-proudify.min.js
proudify.css
proudify.min.css

README.md

Proudify

Proudify is an awesome jQuery plugin to display your GitHub projects and Coderwall badges.

The GitHub projects part is a Javascript only implementation of Chris Oliver's idea called Current Projects, suitable for static web pages.

The CoderWall badges part is based on Herman Junge's idea.

Click here to check it out in action!

Getting Started

You can either copy jquery-proudify.min.js and proudify.min.css or link to them in this repository.

The later is recommended because you will get instant updates and bug fixes without the hassle of updating by yourself.

Install

CSS (skin)

<link rel="stylesheet" href="proudify.min.css" type="text/css"/>

The CSS above is optional and is only required if you do not want to create your own theme.

Javascript

<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.0/jquery.min.js"></script>
<script type="text/javascript" src="jquery-proudify.min.js"></script>

You'll also need a recent version of jQuery as seen above.

Compile from coffescript

coffee -o build -j jquery-proudify.js -c src/renderer.coffee src/github.coffee src/coderwall.coffee src/proudify.coffee

You'll now have a jquery-proudify.js file under the build folder.

Configure

Proudify takes a hash of options as described below:

  • username - your GitHub or Coderwall username (required)
  • service - 'github' or 'coderwall' (default: github)
  • pushed_at - number of days after a repository is considered to be ON HOLD (default: 120 ~ 4 months)
  • num - limit the number of shown repositories (default: 0 - show all)
  • forks - include forks beside your own original repositories (default: false)
  • onhold_status - The text you wish to use for on hold project (defaults to ON HOLD)
  • ongoing_status - The text you wish to use for ongoing projects (defaults to ONGOING)
  • loading_message - The loading message you wish to use (defaults to Loading...)

The last six options are for Github only.

Usage

<div id="proudify"></div>
<script type="text/javascript">
  $('#proudify').proudify({'username':'icebreaker'});
</script>

You can style it at your heart's content, proudify.css is a good starting point if you want to customize or tweak certain things.

TODO

These "features" are in the works and will be added soon :)

  • pull and show other public Github user info
  • show fork & watch count ( suggestion by @amanelis )
  • show public activity feed (with this generic RSS support as well)
  • show tweets
  • 'real time' preview, so anybody could try it before creating his own
  • proudify gem (generate gh-pages, etc) for quick setup

Credits

Contribute

  • Fork the project.
  • Make your feature addition or bug fix.
  • Send me a pull request. Bonus points for topic branches.
  • Do not bump the version number.

License

Copyright (c) 2011, Mihail Szabolcs

Proudify is provided as-is under the MIT license. For more information see LICENSE.