Home

Awesome

Build & Test

Try the resulting object diagram modeler here.

Object-diagram-js

This repository contains the source code for object-diagram-js, based on diagram-js and strongly inspired by the excellent bpmn-js. A demonstration is available here.

Usage

The project is published as a npm package. Usage is similar to bpmn-js and is shown in /starter.

Installing dependencies

npm i
cd starter
npm i

Running the modeler

cd starter
npm start

Build & deploy changes to github-pages

cd starter
npm run build:github-pages

Object-diagram-js debugger

The UI used in the visual debugger IntelliJ plugin is configured in the folder /debugger. This serves as an example how the library can be used and customized (here we added a Websocket connection to read debug data live). The debugger has two more interesting features:

  1. The debugger highlights changes by computing a diff using object-diagram-js-differ: PNG showing a diff

  2. The debugger saves the debugging history such that a user can step back in the UI: Gif showing the history feature

Installing dependencies

npm i
cd starter
npm i

Running the debugger

cd starter
npm run startDebugger

Building the debugger

cd starter
npm run buildDebugger:deploy

The debugger will be build at the right location for the visual debugger plugin.

License

MIT

Contains parts of (bpmn-io) released under the bpmn.io license.

Acknowledgments

I used the excellent postit-js example as a starting point for my project.