Contributing

Timo Tijhof edited this page Jul 22, 2017 · 3 revisions

Development Installation

This is a node.js project, so you need node >0.8.x and the node package manager, npm.

Once that's done, I recommend you install Coco globally so you don't have to futz with your path: npm install -g coco -- if you choose not to, you should probably add ./node_modules/.bin to PATH in your bashrc or something.

Next, install your source checkout in dev mode by running npm link from the project root. This will also download and install all the package dependencies.

Finally, start the server task using Coke (it's like Rake for Coco) with coke server. While this does what it says on the tin, it also seems to have a habit of randomly losing parts of stderr. For now, you can work around this by manually starting the server: coke link && lib/server/server.co

You should now have a server running on 8081.

Project Layout

  • assets/ - static images
  • data/ - json, yaml, csv, etc. files that contain graph configuration and graph content data
  • data/datasources/ - graph content data
  • data/graphs/ - saved graph configurations.
  • lib/ - Coco files. Application logic lives here.
  • lib/{chart,dashboard,dataset,graph}/ - Models and View Classes
  • lib/template/ - client side Jade views. These are included and rendered by View classes.
  • lib/server/ - Server side Coco files.
  • lib/server/server.co - Express server setup. Routing is done here.
  • lib/server/controllers/ - Server side controllers. Routed to by express-resource.
  • www/ - (Mostly) static Jade HTML templates and Stylus CSS templates. The Jade templates are rendered by the server side controllers in lib/server/controllers/.
  • var/ - Compiled JavaScript and CSS files.

Deployment

Coco needs to be compiled down to JavaScript in order for it to be executed. In development environments, this is done on the fly. In production environments, all Coco is compiled down into JavaScript files and placed in a dist/ directory. These JavaScript (and compiled Stylus CSS files) are served up directly to the browser upon request, rather than having to be compiled first.

deploy.sh currently builds a distribution tmp/dist, and then rsyncs this over to reportcard.wmflabs.org. You will need an account with sudo permissions on the reportcard2 wmflabs instance in order to deploy.

Notes

  • This project is written in Coco, a dialect of CoffeeScript -- they both compile down to JavaScript. The pair are very, very similar, except for a few things. If you can read JavaScript and Ruby, you can understand Coco and CoffeeScript. (I refer to the CoffeeScript docs for the syntax, and I find the comparison page to be the best reference for Coco.)

  • Coco requires compilation before it'll run in the browser (though node can run it directly -- #!/usr/bin/env coco will work as a shebang as well). I've written request middleware that recompiles stale files on demand, and it is pretty cool.