gitbar

A plugin for BitBar to quickly show your open source GitHub contribution stats and help set contribution goals, all on your Mac OS X Menu Bar.

Almost all of us have private repos we tend to work on, and it's really easy to neglect your OSS work. So, I created Gitbar to make daily public contributions a habit. Gitbar is a OSX Menu Bar utility that shows your daily GitHub stats, streaks, and contributions. You can even set contribution goals in the application.

Prerequisites

Must be on Mac OSX (Snow Leopard or newer (>= 10.6))
Have Node.js and npm installed

Install

First, download and install BitBar.

Clone the plugin repo:

$ git clone https://github.com/Shikkic/gitbar/

Inside the repo folder, install the dependencies:

$ npm install

Configure

In the root folder you'll need to modify the .env file with your GitHub username. Here you'll also be able to customize contribution goal tracking as well. Simply give the tracking value TRUE or FALSE to turn it on or off, respectively, and provide your ideal goal number to give yourself a completion percentage.

GITHUB_USERNAME="<YOUR_GITHUB_NAME_HERE>"
CONTRIBUTION_GOAL_TRACKING=true
CONTRIBUTION_GOAL="1000"
COMPACT_UI=true

Now, launch BitBar and select the gitbar_plugin folder as your Plugin Folder.

Gotchas

If you have an error resulting from your path to Node, edit the shebang at the top of gh.5m.js to include the correct path.

To find the correct path simply run:

$ which -a node

Dependencies

Obviously BitBar.

I also use the gh-scrape to crawl GitHub and parse selected values from public GitHub profiles. Feel free to contribute if you'd like!

I use this module instead of using the GitHub API for a few reasons. I wanted to make it as easy as possible to setup and requiring users to generate and input an API key made the barrier of entry seem high. Also, this allows us to only focus on publicly available contributions, which was the original intended purpose.

Suggestions, comments?

Feel free to create an issue or reach out on the 💬 BitBar Slack or Twitter @shikkic!

Shikkic / gitbar