https://github.com/bptlab/chor-js-demo
A demo showcasing the chor-js BPMN 2.0 choreography diagram modeler.
https://github.com/bptlab/chor-js-demo
Last synced: about 1 year ago
JSON representation
A demo showcasing the chor-js BPMN 2.0 choreography diagram modeler.
- Host: GitHub
- URL: https://github.com/bptlab/chor-js-demo
- Owner: bptlab
- Created: 2018-11-27T17:14:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-09-23T08:27:19.000Z (over 4 years ago)
- Last Synced: 2023-10-17T05:36:32.060Z (over 2 years ago)
- Language: JavaScript
- Size: 275 KB
- Stars: 23
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# chor-js-demo
__[:rocket: Live Version :rocket:](https://bpt-lab.org/chor-js-demo/)__
A simple demo application showing the usage of the _npm package_ of [`chor-js`](https://github.com/bptlab/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](./app/lib/validator).
> For an example on how to use the pre-packaged version of chor-js, please refer to the [README there](https://github.com/bptlab/chor-js).
## Local Usage
### Node
You can install and run the demo locally using Node.js.
#### Run Only
```shell
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](https://parceljs.org) 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](https://github.com/bptlab/chor-js), you can link the two repositories:
```shell
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.
```shell
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