Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/camunda/camunda-modeler-plugin-example
Plugin example for the Camunda Modeler. Use this as a starting point for creating your own plugins.
https://github.com/camunda/camunda-modeler-plugin-example
camunda camunda-modeler-plugin example
Last synced: about 2 months ago
JSON representation
Plugin example for the Camunda Modeler. Use this as a starting point for creating your own plugins.
- Host: GitHub
- URL: https://github.com/camunda/camunda-modeler-plugin-example
- Owner: camunda
- Created: 2017-03-27T11:35:24.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T13:40:18.000Z (4 months ago)
- Last Synced: 2024-10-31T07:35:04.872Z (2 months ago)
- Topics: camunda, camunda-modeler-plugin, example
- Language: JavaScript
- Homepage:
- Size: 173 KB
- Stars: 9
- Watchers: 21
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Camunda Modeler Plugin Example
 
This example serves as a starting point for creating your own plugin for the [Camunda Modeler](https://github.com/camunda/camunda-modeler).
## Development Setup
Use [npm](https://www.npmjs.com/), the [Node.js](https://nodejs.org/en/) package manager to download and install required dependencies:
```sh
npm install
```
To make the Camunda Modeler aware of your plugin you must link the plugin to the [Camunda Modeler plugin directory](https://docs.camunda.io/docs/components/modeler/desktop-modeler/plugins/#plugging-into-camunda-modeler) via a symbolic link.
Available utilities to do that are [`mklink /d`](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/mklink) on Windows and [`ln -s`](https://linux.die.net/man/1/ln) 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:
```sh
npm run dev
```
Given you've setup and linked your plugin [as explained above](#development-setup), 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:
```sh
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](#badges-to-indicate-typical-plugin-types).
* [ ] Ensure you renamed the [bpmn-js extension](./client/bpmn-js-extension/index.js#L17) 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)](#)`|
|[](#)|`[](#)`|
|[-orange.svg)](#)|`[-orange.svg)](#)`|
|[-orange.svg)](#)|`[-orange.svg)](#)`|
|[](#)|`[](#)`|
|[](#)|`[](#)`|
|[](#)|`[](#)`|
|[](#)|`[](#)`|
|[](#)|`[](#)`|
## Additional Resources
* [List of existing plugins](https://github.com/camunda/camunda-modeler-plugins)
* [Plugins documentation](https://docs.camunda.io/docs/components/modeler/desktop-modeler/plugins/)
## Licence
MIT