Squid for Mac

Squid is a small cool tool that give you a quick access to all your Github repositories/issues, straight from from your Mac OS X menu bar.

Dependencies

• Squid Core and his dependencies.
• nw.js

All data are served by the Github API.

Table of Content

• Installation
• Build app
• Github API Authorization
• Troubleshoots
• Roadmap
• Contributing
• Release History

Installation

First install required packages:

If you want to start from a fresh new install and watch files change, run:

$ gulp

Or run next command to build source and start watch task without download app packages:

watch task will automaticly update application's build when you change one of the following files:

• src/html/*
• src/img/*
• src/js/*
• src/scss/*
• config/*
• github.json

Now you are ready to launch Squid. Go ahead and run into a new terminal window:

Build app

To build a standalone app and his installer run these command:

The freshly builded app will be available into the release folder.

Github API Authorization

As recommended by Github we use the Basic Authentication to create an OAuth2 token:

With this technique, a username and password need not be stored permanently, and the user can revoke access at any time

Troubleshoots

if gulp throw a 'Error: EMFILE, open '/path/to/package.json' error, run the following command:

Roadmap

See the roadmap future developments.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.