sartography
/
bpmn-js-base
mirror of https://github.com/sartography/bpmn-js-base.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

a few more notes in the README.

This commit is contained in:
Dan 2022-09-15 11:39:38 -04:00
parent aad4e2e294
commit 9d979c8167
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -2,11 +2,12 @@
A quick-start repo, designed to be forked and modified to create extensions and modifications to BPMN.io
# About
This project provides a baseline for creating you own modifications to BPMN,io - there are many excellent examples available on the [BPMN.io Repository](https://github.com/bpmn-io/bpmn-js-examples). But they are gathered into one large repository. This is designed to be a SEED project - a good starting point that will let you get up and running quickly.
This project provides a baseline for creating you own modifications to BPMN,io - there are many excellent examples available on the [BPMN.io Examples Repository](https://github.com/bpmn-io/bpmn-js-examples). But they are gathered into one large GIT repo. This is designed to be a SEED project - a good repo to fork, and then start messing around with.
This extension creates a BPMN editor with all the capabilities of [BPMN.js](https://github.com/bpmn-io/bpmn-js) and the following additions / modifications:
In addition to some very lightweight examples for how to extend [BPMN.js](https://github.com/bpmn-io/bpmn-js), this repo shows how to run the full BPMN Modeler in a web browser with your extension in place.
* Changes the color of all the lines to be a pretty blue!
The extension code you will be editing is located in the app/MyExtension directory. Right now it contains:
1. SequenceFlowRenderer - this changes the color of all the lines to be a pretty blue!
## Running the Modeler
@ -18,11 +19,15 @@ To install all project dependencies execute
npm install
```
To start playing around, start the server up in develpment mode. Any changes you make the Javascript files will be authmatically updated.
To start playing around, start the server up in development mode. Any changes you make the Javascript files will be automatically updated.
```sh
npm run dev
```
There are additional commands defined in the package.json that will let you build and share your extension via NPM so that others can incorporate your changes it into their projects.
There are also a ton of dev-dependencies included into the package json that will allow you to create automated tests to verify your extension works. We may add some examples on how to do this in the future.
## License
MIT