Setting up OSMD for Development

This page describes how to set up OpenSheetMusicDisplay for development.

Clone source

# Clone the repository from Github
$ git clone git@github.com:opensheetmusicdisplay/opensheetmusicdisplay.git

Install Grunt

As of today, OSMD requires Grunt for build tasks. This is going to change in the future, since all OSMD build tasks will be moved to npm scripts.

Install Grunt globally:

$ npm install -g grunt-cli

Install dependencies

This requires npm to be installed.

$ npm install

Build

$ grunt build:demo # Builds the demo
$ grunt build:test # Builds the tests
$ grunt build:dist # Builds for distribution on npm and Bower

All bundled build artifacts will be placed in build/. The compiled ES module will be located at dist/.