Developer Tooling and Workflow

Background Information

Javascript and Node

The NPM package manager

Javascript Resources

Bower Package Manager

Grunt

Building and Compressing

Source Maps

Livereload

Tasks

More information

Jasmine and Istanbul

Git Hooks

Editorconfig and jsHint

Cloning and Running the Project

To begin working on the project, fork it on github or clone locally: git clone https://github.com/IIIF/m2.git

Install all dependencies with npm install and bower install. Run grunt.

A good practice is to clone the project into a directory that is being served by a running http server such as apache or nginx. However, if you would like to test and develop without using an external server, you may run grunt serve.

Either visit the root folder of the project at localhost, or, if you are using grunt serve, see the example at localhost:3001

Create a branch for your work: e.g.: git checkout -b my-feature-branch or git checkout -b my-bug-fix

The Usual Development Workflow

Submitting Your Contribution