Dev System Requirements

For development, it is recommended that you use Linux. The maintainer(s) of the project uses Linux as their primary development platform.

It is also possible to setup vagrant on Mac and Windows. On Mac it should be fairly straight forward (confirmed on Mavericks). Windows does not have NFS and therefore will take some more work.

Again, it is recommended that you use the Vagrant Setup (Recommended). This cuts down the number of dependencies and should be much easier to work with.

Projecto’s requirements are fairly light. The vagrantbox only has about 400MB of RAM and it runs just fine.

If you find that setup, especially the Vagrant box, is broken. Notify the maintainer(s) as soon as possible. This is a top priority as new contributors will be blocked and lose interest if the setup instructions do not work.

Vagrant Setup

The requirements for the vagrant setup is fairly light. You need to install the followings:

  • Vagrant
  • NFS - For Windows, ignore this and follow the instructions in Vagrant Setup (Recommended).
  • NodeJS
  • Firefox and Chromium for now.
  • After you get all of this, go to the project root and run npm install.
  • Now remember to add node_modules/.bin to your $PATH.

Instructions for those are available online. So follow them.

Continue to Vagrant Setup (Recommended).