Populations.js

This library originally evolved from the Evolution Readiness project created by the Concord Consortium

Running Locally

This project is built using Brunch.io, which compiles the CoffeeScript, stylesheets, and other assets.

Dependencies

• Node Download an installer or run brew install node
• Bower Run npm install -g bower

Setup Brunch and Project Libraries

You'll need to install the plugins required for the brunch project, as well as libraries the project depends on. Run these commands:

  npm install
  bower install

Starting the Server

Run this command:

  npm start

Now open http://localhost:3333 in your browser. Whenever you make a change to a file the browser will be automatically refreshed. Thanks auto-reload-brunch.

Your files will automatically be built into the /public directory whenever they change.

You can also just run brunch build to simply build the files into /public without starting the server.

Running the tests

Run this command:

  npm test

A new Chrome window will open, and the results of the tests will be shown in your console.

If you have the server running (npm start) then any time you update a file the tests will be re-run.

Running the tests with PhantomJS

• Install the latest version of Node (>= 0.10.11). You can use Node Version Manager.
• Edit the file test/karma.conf.js to change browsers: ['Chrome'] to browsers: ['PhantomJS']
• Run the tests with npm test

Running the model integration tests

Run this command:

  ./test-models.sh

A new Chrome window will open, and the results of the tests will be shown in your console.

The model test files can be found in /test/models/

Libraries and Frameworks Used

• CoffeeScript - Making JavaScript suck less.
• Brunch - Asset Compilation
• Node - For Brunch
• Stylus - CSS Templating

License

Populations.js is Copyright 2014 (c) by the Concord Consortium and is distributed under any of the following licenses:

• Simplified BSD,
• MIT, or
• Apache 2.0.