A BPMN 2.0 rendering toolkit and web modeler. https://bpmn.io/toolkit/bpmn-js/
Go to file
Nico Rehwaldt b0eea3dbef fix(search): correct minification meta-data
Closes #521
2016-04-28 20:43:58 +02:00
assets/bpmn-font chore(font): update font 2016-01-18 14:36:49 +01:00
docs chore(project): update setup instructions 2015-09-30 10:28:04 +02:00
lib fix(search): correct minification meta-data 2016-04-28 20:43:58 +02:00
resources docs(project): add screencast 2016-03-29 09:11:45 +02:00
tasks chore(project): update dev dependencies 2016-01-27 13:31:17 +01:00
test fix(modeling): connections are properly removed 2016-04-28 18:46:06 +02:00
.gitignore chore(gitignore): add .DS_Store 2015-05-19 09:18:55 +02:00
.jshintrc test(project): replace jasmine with mocha 2015-07-15 17:42:37 +02:00
.travis.yml chore(travis): use explicit travis build 2016-02-24 09:10:37 +01:00
.wiredeps chore(Modeler): remove bpmn-moddle id-support 2016-03-17 17:27:13 +01:00
CONTRIBUTING.md feat(space-tool): add create/remove space behaviour 2015-04-16 10:00:18 +02:00
Gruntfile.js chore(project): remove jsdoc" 2015-10-21 16:31:26 +02:00
LICENSE chore(project): update license 2016-01-07 15:52:40 +01:00
README.md docs(README): add explainatory screen cast 2016-03-29 09:15:52 +02:00
index.js chore(project): add index.js entry point 2014-06-11 14:36:26 +02:00
package.json chore(project): release v0.14.1 2016-03-23 15:44:30 +01:00

README.md

The project is still in an early stage. Documentation may be missing and examples may be broken.

bpmn-js - BPMN 2.0 for the web

Build Status

bpmn-js is a BPMN 2.0 diagram rendering toolkit and web modeler.

bpmn-js in action

Usage

No need for additional setup: Try out our seed project or use the pre-packaged version of the library.

Get the library via npm or Bower and use it in your web applications to display BPMN 2.0 diagrams.

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');
  }
});

Install bpmn-js

via bower

bower install bpmn-js

Make sure to include the library + all dependencies into the website.

Checkout an example project that shows how to use the library in web applications.

via npm

npm install --save bpmn-js

Make sure you use browserify or the like to bundle your project and bpmn-js for the browser.

Checkout an example project that shows how to use bpmn-js in node-style web applications.

Resources

Tools

bpmn-js builds on top of a few additional powerful tools

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

Building the Project

As long as the project is in alpha stage, you must make sure you setup the whole development environment, including a number of project dependencies according to our development setup.

License

Use under the terms of the bpmn.io license.