Camunda Modeler Plugin Example

This example serves as a starting point for creating your own plugin for the Camunda Modeler.

Development Setup

Use npm, the Node.js package manager to download and install required dependencies:

npm install

To make the Camunda Modeler aware of your plug-in you must link the plug-in to the Camunda Modeler plug-in directory via a symbolic link. Available utilities to do that are mklink /d on Windows and ln -s on MacOS / Linux.

Re-start the app in order to recognize the newly linked plug-in.

Building the Plug-in

You may spawn the development setup to watch source files and re-build the client plug-in on changes:

npm run dev

Given you've setup and linked your plug-in as explained above, you should be able to reload the modeler to pick up plug-in changes. To do so, open the app's built in development toos via F12. Then, within the development tools press the reload shortcuts CTRL + R or CMD + R to reload the app.

To prepare the plug-in for release, executing all necessary steps, run:

npm run all

Before you Publish

• Clearly state which Camunda Modeler version your plug-in is compatible with
• Ensure you renamed the bpmn-js extension from PLEASE_CHANGE_ME to something unique

Additional Resources

• Example Plugins
• Plugins documentation

Licence

MIT