src/main/resources/META-INF/resources/designer/modeler/README.md

   1 # bpmn-js Modeler Example
   2
   3 This example uses [bpmn-js](https://github.com/bpmn-io/bpmn-js) to implement a modeler for BPMN 2.0 process diagrams. It serves as the basis of the bpmn-js demo application available at [demo.bpmn.io](http://demo.bpmn.io).
   4
   5 ## About
   6
   7 This example is a node-style web application that builds a user interface around the bpmn-js BPMN 2.0 modeler.
   8
   9 ![demo application screenshot](https://raw.githubusercontent.com/bpmn-io/bpmn-js-examples/master/modeler/docs/screenshot.png "Screenshot of the example application")
  10
  11
  12 ## Building
  13
  14 You need a [NodeJS](http://nodejs.org) development stack with [npm](https://npmjs.org) and [grunt](http://gruntjs.com) installed to build the project.
  15
  16 To install all project dependencies execute
  17
  18 ```
  19 npm install
  20 ```
  21
  22 Build the application (including [bpmn-js](https://github.com/bpmn-io/bpmn-js)) using [browserify](http://browserify.org) via
  23
  24 ```
  25 grunt
  26 ```
  27
  28 You may also spawn a development setup by executing
  29
  30 ```
  31 grunt auto-build
  32 ```
  33
  34 Both tasks generate the distribution ready client-side modeler application into the `dist` folder.
  35
  36 Serve the application locally or via a web server (nginx, apache, embedded).