Gimli

Github Issues Messenger

Gimli is currently a work in progress.

Build Status

Usage

• Install Node.js: brew install nodejs
• Run npm install -g grunt-cli to be able to run tasks
• Run npm install -g bower to be able to install client dependencies
• Install Redis: brew install redis
• Install MongoDB: brew install mongodb
• Clone this repo
• Run npm install from the project folder to install server dependencies
• Run bower install from the project folder to install client dependencies

Required Environmental Variables

All required environmental variables except two will be setup by our gruntfile.js tasks. To hook up to github authentication you'll need to create an application and then setup two environment variables. You can do this by creating a ~/.env file with the following content:

GITHUB_CLIENT_ID=<client id for your github application>
GITHUB_CLIENT_SECRET=<client secret for your github application>

You can look at our gruntfile.js to see what other environment variables you can override.

Building

To build the project (process client side assets into the /dist folder) run:

grunt build

Running

This will start up the node server under nodemon to automatically reload when files get edited:

grunt start

Development

If you edit the bower.json file you'll need to run bower install to fetch any new dependencies.

Tests

brew install phantomjs
grunt test