bpmn-js/docs/project/SETUP.md

Project Setup

This document describes the necessary steps to setup a bpmn-js development environment.

TLDR;

On Linux, OS X or Windows? git, NodeJS and npm ready? Check out the setup script section below.

Manual Steps

Make sure you have git, NodeJS, npm and Grunt installed before you continue.

Get Project + Dependencies

The following projects from the bpmn-io project on GitHub

• bpmn-js
• diagram-js
• bpmn-moddle

and clone them into a common directory via

git clone git@github.com:bpmn-io/bpmn-js.git
git clone git@github.com:bpmn-io/diagram-js.git
git clone git@github.com:bpmn-io/bpmn-moddle.git

Link Projects

Link dependent projects between each other to pick up changes immediately.

.
├─bpmn-js
│   └─node_modules
│       ├─diagram-js <link>
│       └─bpmn-moddle <link>
├─diagram-js
├─bpmn-moddle

On OS X, Linux

Use npm-link or ln -s <target> <link>.

On Windows

Use mklink /d <link> <target> (docs).

Install Dependencies

Execute npm install on each of the projects to grab their dependencies.

Verify Things are O.K.

Execute grunt on each project. Things should be fine.

Setup via Script

The whole setup can be automated through setup scripts for Linux/OS X and Windows.