To setup and develop we recommend you use a Linux Distribution, we prefer Ubuntu but any would suffice.

Lazy one-liner (Ubuntu only)

git clone https://github.com/MARIE-js/MARIE.js.git && cd MARIE.js && sudo apt-get install npm && sudo npm install -g grunt-cli && npm install && grunt bar-dev

Dependencies Required

• npm
• grunt-cli

This dependency is only required for testing the code:

• JRE 8

Setup

Firstly, you need to install the above dependencies as specified.

Then, whenever you want to work on the project from time to time, you must first change directories into the git project, pull the latest changes from GitHub, and run npm install to install rest of the dependencies.

cd /path/to/repo/MARIE.js

# Pulls the latest changes from GitHub
git pull

# Installs any uninstalled dependencies
npm install

Once you done this part, you're ready to build the project.

Build

The development version builds faster, but the release version is designed to be slightly more efficient and compatible to more browsers.

Release

grunt

Note: For Arch Linux and perhaps for some other Linux distributions, it may fail on the regenerator task. If this happens, then just build the development version which does not depend on the regenerator task.

Development

grunt bar-dev

Testing

# To test MARIE.js (you need JRE 8 to run htmllint):
grunt test