________                        __
 /_  __/ /_  ________  ____ _____/ /____
  / / / __ \/ ___/ _ \/ __ `/ __  / ___/
 / / / / / / /  /  __/ /_/ / /_/ (__  )
/_/ /_/ /_/_/   \___/\__,_/\__,_/____/

Installation

Install libsass. On Mac OS X:

$ brew install libsass

If you don't have it installed already, install the gulp cli package globally.

$ npm install -g gulp

Install local dependencies:

$ npm install

Local Development

First, create a config/local.js file by copying config/local.example.js and making any desired changes.

$ cp config/local.example.js config/local.js
$ $EDITOR config/local.js

To build the app, start a development server on port 8000, and rebuild automatically on changes, run gulp's default task:

$ NODE_ENV=local.js gulp
$ # for port override:
$ PORT=8000 gulp

The frontend of threads will look for a backend (API) connection on the host specified in the apiUrl config parameter in your config/local.js.

View a list of the gulp tasks with:

$ gulp help

Bulding the Docs

To build the docs install wintersmith globally:

$ npm install -g wintersmith
$ cd docs/
$ wintersmith build

If you want to edit them without having to build on every change, just run:

$ wintersmith preview

Production Build

The Jenkins server is polling for changes to the master branch every 5 minutes. When a change is detected, a build is run. Upon successful build, a deploy to production will occur.