camunda / camunda-modeler-plugin-example

Plugin example for the Camunda Modeler. Use this as a starting point for creating your own plugins.

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 plugin you must link the plugin to the Camunda Modeler plugin 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 plugin.

Building the Plugin

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

npm run dev

Given you've setup and linked your plugin as explained above, you should be able to reload the modeler to pick up plugin 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 plugin for release, executing all necessary steps, run:

npm run all

Before you Publish

• Clearly state which Camunda Modeler version your plugin is compatible with and which type of plugin it is by changing the badges at the top of this README. See best-practice examples below.
• Ensure you renamed the bpmn-js extension from PLEASE_CHANGE_ME to something unique
• Ensure you've removed the menu and style folders as well as their references in ./index.js if you do not need them

Badges to indicate typical plugin types

Badge	Markdown
	[](#)
	[-orange.svg)](#)
	[-orange.svg)](#)
	[](#)
	[-orange.svg)](#)
	[-orange.svg)](#)
	[](#)
	[](#)
	[](#)
	[](#)
	[](#)

Additional Resources

• List of existing plugins
• Plugins documentation

Licence

MIT