Marketplace Stats

Marketplace statistics app based on commonplace.

Installation

npm install
npm install -g commonplace

Flue

Comprehensive Flue documentation can be found in Flue's README.

Usage

From the terminal, run the following command

damper

This will start a local server on 0.0.0.0:8675 by default.

To control the hostname and port you can use the following otions

damper --host 127.0.0.1 --port 8888

In addition to an HTTP server, the damper will also run a Stylus watcher (to recompile CSS as it's edited) and a template watcher (to recompile templates as they're edited).

For instructions on running Flue (the mock API server), please see the Flue docs.

Compiling

To run the compilation process, which compiles templates, CSS, and locale files, run the following command:

commonplace compile

Compiling Includes

If you need to compile include files (i.e.: for Space Heater or a less HTTP- heavy version of the project), run commonplace includes. This will generate two files:

hearth/media/js/include.js
hearth/media/css/include.css

The CSS in include.css is generated in the order in which CSS files are included in hearth/index.html.

include.js uses a lightweight AMD loader (rather than require.js). This keeps file size down and also makes it possible to name-mangle internal keywords which otherwise wouldn't be minifiable. Note that the only safe globals are require and define---using any other non-browser globals will result in errors. I.e.: accessing _ without requiring 'underscore' will cause the code to fail. Also note that all modules must include a name as the first parameter.

Localizing

A detailed guide to extracting strings and creating JS language packs can be found on the wiki.

The API

Read the docs.

Tests

Install casper

brew install casperjs