Skip to content

surefire/surefirething.co.uk

Repository files navigation

SureFireThing.co.uk

SureFire's website. Powered by the Express web application framework for Node.js using CoffeeScript, Jade and LESS.

Requirements

Installation

Clone the repository:

$ git clone --recursive [email protected]:surefire/surefirething.co.uk.git

Start the application with Foreman:

$ foreman start
00:00:01 web.1 | started with pid 99999
00:00:01 web.1 | > [email protected] prestart /path/to/surefirething.co.uk
00:00:01 web.1 | > ./node_modules/.bin/cake build
00:00:01 web.1 | > [email protected] start /path/to/surefirething.co.uk
00:00:01 web.1 | > node ./lib/server.js
00:00:01 web.1 | SureFire server listening on 0.0.0.0:3000

Automation

Grunt is used as a task runner. In order to get started, you'll want to install Grunt's command line interface (CLI) globally.

$ npm install -g grunt-cli

This will put the grunt command in your system path, allowing it to be run from any directory.

Documentation

Annotated source documentation can be generated using Docco and Pygments:

$ sudo easy_install Pygments
$ grunt docco
Running "docco:src" (docco) task
docco: ./lib/app.coffee -> docs/app.html
docco: ./lib/server.coffee -> docs/server.html

Done, without errors.
...

Authors

Copyright

Copyright (c) 2012 SureFire. See LICENSE for details.

Releases

No releases published

Packages

No packages published