Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.63 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.63 KB
Raw

chor-js-demo

🚀 Live Version 🚀

A simple demo application showing the usage of the npm package of chor-js to view and edit BPMN 2.0 choreography diagrams in the browser.

The demo also adds some features such as diagram upload and download, and a validator.

For an example on how to use the pre-packaged version of chor-js, please refer to the README there.

Local Usage

Node

You can install and run the demo locally using Node.js.

Run Only

npm install
npm run dev

You can also build it using npm run build.

The demo is then served to http://localhost:9013. We use Parcel as a build tool. Thus, unless you set up the project as a development environment (see below), chor-js will not be transpiled and polyfilled, which should be no problem for modern browsers.

Development Environment

If you want to use the demo while developing chor-js, you can link the two repositories:

git clone https://github.com/bptlab/chor-js.git
cd chor-js
npm install
npm link

cd ..
git clone https://github.com/bptlab/chor-js-demo.git
cd chor-js-demo
npm install
npm link chor-js
npm run dev

Docker

We also provide a Dockerfile to use with Docker.

docker build . -t chor-js-demo
docker run --rm -p 9013:9013 --name chor-js-demo -it chor-js-demo

The demo is then served to http://localhost:9013 as a production build using the latest version of chor-js (see Dockerfile).

License

MIT