Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bpmn-io/bpmn-js-token-simulation
A BPMN 2.0 specification compliant token simulator.
https://github.com/bpmn-io/bpmn-js-token-simulation
bpmn bpmn-engine bpmn-js hacktoberfest simulator
Last synced: 3 months ago
JSON representation
A BPMN 2.0 specification compliant token simulator.
- Host: GitHub
- URL: https://github.com/bpmn-io/bpmn-js-token-simulation
- Owner: bpmn-io
- License: mit
- Created: 2017-08-18T14:33:19.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-11T13:02:34.000Z (4 months ago)
- Last Synced: 2024-10-13T16:13:15.704Z (4 months ago)
- Topics: bpmn, bpmn-engine, bpmn-js, hacktoberfest, simulator
- Language: JavaScript
- Homepage: https://bpmn-io.github.io/bpmn-js-token-simulation/modeler.html?e=1&pp=1
- Size: 14.9 MB
- Stars: 248
- Watchers: 22
- Forks: 71
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bpmn-io - bpmn-js-token-simulation - Simulate tokens running through your process (Extensions)
README
# bpmn-js Token Simulation
[](https://github.com/bpmn-io/bpmn-js-token-simulation/actions?query=workflow%3ACI)
A BPMN 2.0 specification compliant token simulator, built as a [bpmn-js](https://github.com/bpmn-io/bpmn-js) extension.
[](https://bpmn-io.github.io/bpmn-js-token-simulation/modeler.html?e=1&pp=1)
Try it on the [classic booking example](https://bpmn-io.github.io/bpmn-js-token-simulation/modeler.html?e=1&pp=1&diagram=https%3A%2F%2Fraw.githubusercontent.com%2Fbpmn-io%2Fbpmn-js-token-simulation%2Fmaster%2Ftest%2Fspec%2Fbooking.bpmn) or checkout the [full capability demo](https://bpmn-io.github.io/bpmn-js-token-simulation/modeler.html?e=1&pp=1&diagram=https%3A%2F%2Fraw.githubusercontent.com%2Fbpmn-io%2Fbpmn-js-token-simulation%2Fmaster%2Fexample%2Fresources%2Fall.bpmn).
## Installation
Install via [npm](http://npmjs.com/).
```
npm install bpmn-js-token-simulation
```
## Usage
Add as additional module to [bpmn-js](https://github.com/bpmn-io/bpmn-js).
### Modeler
```javascript
import BpmnModeler from 'bpmn-js/lib/Modeler';
import TokenSimulationModule from 'bpmn-js-token-simulation';
const modeler = new BpmnModeler({
container: '#canvas',
additionalModules: [
TokenSimulationModule
]
});
```
### Viewer
```javascript
import BpmnViewer from 'bpmn-js/lib/NavigatedViewer';
import TokenSimulationModule from 'bpmn-js-token-simulation/lib/viewer';
const viewer = new BpmnViewer({
container: '#canvas',
additionalModules: [
TokenSimulationModule
]
});
```
## Build and Run
Prepare the project by installing all dependencies:
```sh
npm install
```
Then, depending on your use-case you may run any of the following commands:
```sh
# build the library and run all tests
npm run all
# run the full development setup
npm run dev
# spin up the example
npm run start:example
```
## Additional Resources
* [Talk: Making of token simulation](https://nikku.github.io/talks/2021-token-simulation) - The case for token simulation and how it builds on top of [bpmn-js](https://github.com/bpmn-io/bpmn-js)
* [Talk: Token simulation internals](https://nikku.github.io/talks/2021-token-simulation-internals) - Detailed walk through the simulators core
* [Talk: Your next BPMN engine](https://page.camunda.com/ccs2022-bpmn-js-token-simulation) - How we turned this project into a BPMN 2.0 spec compliant simulator
* [Camunda Modeler Token Simulation plug-in](https://github.com/camunda/camunda-modeler-token-simulation-plugin) - Token simulation for [Camunda](https://camunda.com/) users
## Licence
MIT