:octocat: Open source github contribution stats on your Mac OS X Menu Bar

Related tags

bitbar
Overview

gitbar

:octocat: 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. :octocat:

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.

dank application screenshot

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.

Imgur

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!

Issues
  • Getting undefined values

    Getting undefined values

    I'm getting some undefined values. Is it possible that this is caused by GitHub recently removing the streak display on user's profiles?

    screenshot 2016-06-05 at 21 49 26

    opened by KCreate 11
  • Font size, Emoji parsing, Menu bar style detection

    Font size, Emoji parsing, Menu bar style detection

    Hi! I added 3 things here:

    • Adjust font size to match default menubar font size. As it is right now, the font size is just a pixel off the desired size of the rest of the menu bar, making the font ever so slightly misaligned. This should fix that.
    • Use BitBar's built-in Github style emoji parsing. BitBar supports using :broken_heart: and stuff, thought I'd switch that so that you don't have to find the unicode characters for emojis.
    • Lastly, Add user menu bar style detection. When I installed this bitbar plugin, the "Completion" line was invisible as black color does not display on the menu bar if the user has their Mac menu bar set to Dark. This patch will determine whether to use white (for dark mode) or black (for light mode) using $ defaults read -g AppleInterfaceStyle shell command.

    Let me know what you think!

    opened by qasim 3
  • bump gh-scrape version to 1.1.0

    bump gh-scrape version to 1.1.0

    Brings in a new more compatible version of gh-srape. Should get things working again.

    opened by Shikkic 3
  • License?

    License?

    Could you put a license on this so others will be more likely to contribute? (presuming you want to make this FOSS) Thanks!

    opened by stacybird 2
  • spelling

    spelling

    opened by johnbickmore 1
  • Use sample.env instead of .env

    Use sample.env instead of .env

    Everytime I pull a new version of your project, I have to update the .env file. If you rename the .env file to sample.env and put .env in the .gitignore, it will save us users of gitbar just a slight headache in keeping up with the latest version. :zap: :zap:

    opened by nlaz 1
  • Minor grammar & spelling, edit links

    Minor grammar & spelling, edit links

    Add CamelCase to GitHub and BitBar, remove BitBar as a prereq (because it's included in the installation instructions), add links to Twitter, fix minor typos.

    opened by cassidoo 0
  • Redesign layout

    Redesign layout

    Merge in a new design!

    opened by Shikkic 0
  • Track a daily contribution goal

    Track a daily contribution goal

    I've added the feature to track daily contribution goals. This adds the following environment variables to the .env config file:

    • CONTRIBUTION_GOAL_DAILY_TRACKING - enable / disable
    • CONTRIBUTION_GOAL_DAILY - The daily contribution goal

    If CONTRIBUTION_GOAL_DAILY_TRACKING is set to true, the app now behaves as follows:

    • If the daily contributions are 0, the emoji is set to 💔
    • If the daily contributions are lower than the daily goal, the emoji is set to 📈
    • If the daily contributions are higher or equal than the daily goal, the emoji is set to ⭐

    This pull request also fixes a bug where setting CONTRIBUTION_GOAL_TRACKING to false would still show the contribution goal.

    screenshot 2016-06-07 at 19 03 10

    Any more thoughts on this?

    opened by KCreate 5
  • Merge into bitbar plugins repo

    Merge into bitbar plugins repo

    Would love to have this plugin officially be merged into bitbar's plugin repo. I was told that it might need to be compiled to a binary since it has hard dependencies.

    Should consider looking into https://github.com/jaredallard/nexe, definitely want to create a PR soon.

    opened by Shikkic 0
  • Update README

    Update README

    Just merged in a PR from @nlaz to rename the .env to sample-env to better preserve peoples configuration changes. Should update the readme to include this information.

    opened by Shikkic 1
Releases(v1.0)
Owner
Dan Cadden
Engineering Manager, Platform @dailymuse, Previously @AvenirHQ, @columbia, @Skillshare, Temple, @recursecenter '16, hackNY @alumNY '15, Slime Time Live '04
Dan Cadden
MySQL/MariaDB database management for macOS

Sequel Ace Sequel Ace is the "sequel" to longtime macOS tool Sequel Pro. Sequel Ace is a fast, easy-to-use Mac database management application for wor

Sequel-Ace 3.6k Sep 17, 2021
The unofficial WWDC app for macOS

The unofficial WWDC app for macOS Enjoy WWDC from the comfort of your Mac with the unofficial WWDC app for macOS. Whether you're (virtually) attending

Guilherme Rambo 8.1k Sep 22, 2021
OS X and iOS application and framework to play with the Apple Push Notification service (APNs)

Pusher OS X and iOS application and framework to play with the Apple Push Notification service (APNs) Installation Install the Mac app using Homebrew

noodlewerk 6.1k Sep 15, 2021
MQTT X - Elegant Cross-platform MQTT 5.0 Desktop Client

MQTT X English | 简体中文 | 日本語 MQTT X is a cross-platform MQTT 5.0 client tool open sourced by EMQ, which can run on macOS, Linux and Windows, and suppor

Scalable Enterprise MQTT Broker 1.3k Sep 22, 2021
:closed_book: Swift Logging Utility for Xcode Google Docs

QorumLogs Swift Logging Utility in Xcode & Google Docs Log Levels class MyAwesomeViewController: UIViewController { override func viewDidLoad() {

Goktug Yilmaz 782 Aug 28, 2021
Manage your vagrant machines in one place with Vagrant Manager for OS X

Looking for the Windows version? Check out Vagrant Manager for Windows Vagrant Manager for OS X Vagrant Manager is an OS X status bar menu app that le

Lanayo Technology 1.9k Sep 14, 2021
Fork of Pieter's nice git GUI for OS X. Includes branch/tag sidebar and various fixes. Current development focus is on removing legacy git command line usage in favour of libgit2 and objective-git.

What is GitX? GitX is a graphical client for the git version control system, written specifically for OS X Mavericks. This means that it has a native

Rowan James 2.1k Sep 8, 2021
The easiest way to get started with PostgreSQL on the Mac

Postgres.app The easiest way to run PostgreSQL on your Mac Includes everything you need to get started with PostgreSQL Comes with a pretty GUI to star

Postgres.app 6k Sep 14, 2021
Hosts file manager for OS X

Gas Mask Gas Mask is simple hosts file manager for macOS. It allows editing of host files and switching between them. System requirements Runs on Lion

Siim Raud 3.3k Sep 23, 2021
The Git interface you've been missing all your life has finally arrived.

GitUp Work quickly, safely, and without headaches. The Git interface you've been missing all your life has finally arrived. Git recently celebrated it

GitUp 9.8k Sep 19, 2021
A free, native Apple macOS app for testing HTTP/REST endpoints

About CocoaRestClient is a Mac OS X app for testing HTTP/Restful endpoints. I love curl, but sometimes I need my output XML or JSON pretty printed. I

Mike Mattozzi 2.2k Sep 22, 2021
A simple but highly customizable `UICollectionViewLayout` for `UICollectionView`.

CollectionViewPagingLayout Layout Designer SnapshotTransformView ScaleTransformView StackTransformView Custom implementations About This is a simple b

Amir Khorsandi 1.4k Sep 22, 2021
A scriptable scratchpad for developers. In slow yet steady progress.

Boop. Website • Download from GitHub • Get on the Mac App Store Documentation • Find more scripts How to get Boop There are four ways to get Boop. You

Ivan Mathy 2.2k Sep 23, 2021
Mac browser for Mach-O binaries (macOS, iOS, watchOS, and tvOS)

Mach-O Browser Mach-O Browser – A Mac application for browsing the contents of Mach-O (Mach Object) files, including executables, shared libraries, an

David Schweinsberg 95 Sep 19, 2021
GUI image optimizer for Mac

ImageOptim ImageOptim is a GUI for lossless image optimization tools: Zopfli, PNGOUT, OxiPNG, AdvPNG, PNGCrush, JPEGOptim, Jpegtran, Guetzli, Gifsicle

ImageOptim 7.3k Sep 18, 2021
MySQL/MariaDB database management for macOS

Sequel Pro Sequel Pro is a fast, easy-to-use Mac database management application for working with MySQL & MariaDB databases. You can find more details

Sequel Pro 8.5k Sep 14, 2021
Mac GUI for pngquant, pngnq and posterizer

ImageAlpha ImageAlpha is a Mac OS X GUI for pngquant, pngnq and posterizer. These tools reduce filesize of PNG files while preserving the alpha channe

Kornel 460 Sep 13, 2021
A Mac app for checking Xcode projects for unused resources

Unused - Mac App ================ version 1.0 Created by: Jeff Hodnett [email protected] http://www.jeffhodnett.com Use this useful utility tool to

Jeff Hodnett 1.4k Aug 16, 2021
Apache NetBeans

Apache NetBeans Apache NetBeans is an open source development environment, tooling platform, and application framework. Build status GitHub actions Tr

The Apache Software Foundation 1.7k Sep 24, 2021