After reading this Readme, see ./web-src/coffee/ for more information about the CoffeeScript developing and its directory structure.



You can run the scripts/ script, it will setup the current working directory, or you can do the following steps:

Install CoffeeScript Compiler

  1. Install nodejs and npm.
  2. Install coffee by executing sudo npm install --global coffeescript
  3. Test the coffee command, it must open a CoffeeScript shell. Exit with Ctrl d.

Compile CoffeeScript

Use the scripts/ script located under the root project directory.

Use scripts/ WHAT to compile one part of the CoffeeScript code when developing. Example: scripts/ tests for compiling the tests suite.

Installing Coffee script on Eclipse Mars.1 Release (4.5.1)

Generating js code from coffee script Eclipse Mars.1 Release (4.5.1)

  1. Create an External Tools Configuration
  2. Location: add path to compile
  3. Working Directory: path to Eclipse project.


At the ./test/ directory you'll find proper fish scripts for running tests.



Install PHPUnit for testing.


cd tests


Use doxygen or doxywizard (the Doxygen GUI) for compiling the PHP documentation on docs/doxygen.

CoffeeScript Documentation

We use codo. However, docco can be used too.

For installing codo:

sudo npm install -g codo

For installing docco:

sudo npm install -g docco

Compiling documentation:

Use scripts/ from the project root directory for creating documentation with the codo program.

Use scripts/ t for compiling using both codo and docco.


Images :

    Quickly fuzzy find classes, mixins, methods, file:

    Control the navigation frame:

    You can focus and blur the search input: