#gitbar
Gitbar is a plugin for bitbar to quickly show your open soure github contribution stats and help set contribution goals, all on your Mac OS X Menu Bar.
We all 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 goals.
- Must be on Mac OSX (Snow Leopard or newer (>= 10.6))
- Have bitbar installed
- Have Node and NPM installed
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
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 off or on, and provide your ideal goal number to give yourself a percent completion.
USER_URL="http://github.com/<YOUR_GITHUB_NAME_HERE>"
CONTRIBUTION_GOAL_TRACKING=TRUE
CONTRIBUTION_GOAL="1000"
Now launch bitbar and select the gitbar_plugin
folder as your Plugin Folder.
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
Obiviously 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 avialable contributions, which was the intended purpose anyway.
Feel free to create an issue or reach out on the ๐ฌ bitbar slack or twitter @shikkic