Home

Awesome

Brickify

Installation

$ git clone https://github.com/brickify/brickify.git

$ cd brickify

Install dependencies: $ npm install

Link git hooks for automatic code tests and style checks: $ npm run linkHooks

Start Server

$ npm start

In order to continuously rebuild the project and restart the server when source files change you can use supervisor. Install it globally with $ npm install -g supervisor and use it like this: $ supervisor -i build -e node,coffee -- node_modules/coffee-script/bin/cake start (Only necessary for server-side scripts as front-end gets build on the fly.)

Scripts

Run $ npm run to list available scripts. Execute a script like: $ npm run <script-name>

Following scripts are currently available:

Package management

We use npm for package management. In order to bundle the modules for the browser we use browserify.

Documentation

We use groc for code documentation and CroJSDoc for api documentation.

Call $ npm run documentation and $ npm run apiDocumentation respectively.

Styleguide

The code must be formatted as described in https://github.com/style-guides/CoffeeScript/tree/v0.1.1

Server

The server currently serves: