kevintuhumury / dashing-coderwall

Dashing widget to show off your Coderwall achievements.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Coderwall widget for Dashing

With the Coderwall widget you can show off your achievements (badges) collected on Coderwall. It will retrieve new data every hour. It doesn't really need to be more frequent than that (it could even be a lot less than that), since Coderwall updates achievements approximately once a week.

Coderwall basically is a website that provides developers and any associated teams the opportunity to specify their skills, experiences and interest. Based on your github repositories, you can earn unique Coderwall badges for all major language types you've used, representing your skills and level-up. A few examples of these achievements (and thus the widget itself) can be seen below.

Dependencies

The Coderwall widget depends on the json gem. So, add json to the Gemfile of your Dashing dashboard:

gem "json"

This widget has been Hamlified (we're using a HAML template in the /widgets/coderwall directory instead of an HTML template), so besides the above you'll also need to add haml to the Gemfile (if you haven't already):

gem "haml"

and require it in your config.ru file right below the require of dashing itself. So the first few lines of your config.ru should look something like the following:

require 'dashing'
require 'haml'

configure do
...

Now run bundle install.

Usage

To use this widget, copy coderwall.coffee, coderwall.haml and coderwall.sass into the /widgets/coderwall directory of your dashboard. Copy the coderwall.png image to the /assets/images directory and place the /jobs/coderwall.rb file in the /jobs folder.

To include the widget on your dashboard, add the following snippet to the dashboard layout file:

<li data-row="1" data-col="1" data-sizex="1" data-sizey="1">
  <div data-id="coderwall" data-view="Coderwall"></div>
</li>

When you're using a Hamlified dashboard layout (hey, you're already using a Hamlified widget, so why not Hamlify your dashboard layout?), you could also do the following:

%li(data-row="1" data-col="1" data-sizex="1" data-sizey="1")
  %div(data-id="coderwall" data-view="Coderwall")

Now, let's move on to the next section and configure your widget. Once that's done, you should be able to start using it!

Configuration

To actually show of your achievements, you'll need to enter your Coderwall username in the jobs/coderwall.rb file. Simply change the username setting below to your own:

# widget configuration

username = "YOUR_USERNAME"

That's it!

Preview

image

Copyright

Copyright 2013 Kevin Tuhumury. Released under the MIT License.

About

Dashing widget to show off your Coderwall achievements.

License:MIT License


Languages

Language:CSS 51.4%Language:CoffeeScript 36.3%Language:Ruby 12.3%