intelogie/bpmn-js

The project is still in an early stage. Documentation may be missing and examples may be broken., _(*1)

bpmn-js - BPMN 2.0 for the web

, _(*2)

bpmn-js is a BPMN 2.0 diagram rendering toolkit and web modeler., _(*3)

, _(*4)

Usage

No need for additional setup: Try out our seed project or use the pre-packaged version of the library., _(*5)

Get the library via npm or Bower and use it in your web applications to display BPMN 2.0 diagrams., _(*6)

var BpmnViewer = require('bpmn-js');

var xml; // my BPMN 2.0 xml
var viewer = new BpmnViewer({ container: 'body' });

viewer.importXML(xml, function(err) {

  if (err) {
    console.log('error rendering', err);
  } else {
    console.log('rendered');
  }
});

Installation

Fetch bpmn-js prebuilt or install it via npm., _(*7)

Fetch Prebuilt

The bower-bpmn-js repository contains pre-built bundles of bpmn-js., _(*8)

Download them directly or fetch them with Bower:, _(*9)

bower install bpmn-js

Checkout the example project to get started., _(*10)

Install via npm

Fetch the library via npm to get fine grained access to the parts you need:, _(*11)

npm install --save bpmn-js

Make sure you use browserify or the like to bundle your project and bpmn-js for the browser., _(*12)

Checkout the example project to learn more., _(*13)

Resources

• Demo
• Issues
• Examples
• Forum

Building the Project

Perform the following steps to build the library, including running all tests:, _(*14)

cd bpmn-js
npm install
npm run all

You may need to perform additional project setup when building the latest development snapshot., _(*15)

Please checkout our contributing guidelines if you plan to file an issue or pull request., _(*16)

Related

bpmn-js builds on top of a few additional powerful tools:, _(*17)

• bpmn-moddle: Read / write support for BPMN 2.0 XML in the browsers
• diagram-js: Diagram rendering and editing toolkit

License

Use under the terms of the bpmn.io license., _(*18)