{"id":19767180,"url":"https://github.com/camunda/camunda-modeler-plugin-example","last_synced_at":"2025-04-30T15:32:46.577Z","repository":{"id":38361883,"uuid":"86327831","full_name":"camunda/camunda-modeler-plugin-example","owner":"camunda","description":"Plugin example for the Camunda Modeler. Use this as a starting point for creating your own plugins.","archived":false,"fork":false,"pushed_at":"2024-09-10T13:40:18.000Z","size":177,"stargazers_count":9,"open_issues_count":0,"forks_count":11,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-04-06T02:51:12.448Z","etag":null,"topics":["camunda","camunda-modeler-plugin","example"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/camunda.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-27T11:35:24.000Z","updated_at":"2024-09-10T13:46:39.000Z","dependencies_parsed_at":"2023-12-21T13:11:21.147Z","dependency_job_id":"654c3475-0882-479e-bb58-00eaa968e8c5","html_url":"https://github.com/camunda/camunda-modeler-plugin-example","commit_stats":{"total_commits":53,"total_committers":9,"mean_commits":5.888888888888889,"dds":0.6037735849056604,"last_synced_commit":"6ee0ae77fce75ecb7c17f4ac210e80737285726e"},"previous_names":[],"tags_count":4,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/camunda%2Fcamunda-modeler-plugin-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/camunda%2Fcamunda-modeler-plugin-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/camunda%2Fcamunda-modeler-plugin-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/camunda%2Fcamunda-modeler-plugin-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/camunda","download_url":"https://codeload.github.com/camunda/camunda-modeler-plugin-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251732345,"owners_count":21634766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["camunda","camunda-modeler-plugin","example"],"created_at":"2024-11-12T04:28:17.949Z","updated_at":"2025-04-30T15:32:46.317Z","avatar_url":"https://github.com/camunda.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Camunda Modeler Plugin Example\r\n\r\n![Compatible with Camunda Modeler version 5](https://img.shields.io/badge/Modeler_Version-5.0.0+-blue.svg) ![Plugin Type](https://img.shields.io/badge/Plugin%20Type-BPMN-orange.svg) \r\n\r\nThis example serves as a starting point for creating your own plugin for the [Camunda Modeler](https://github.com/camunda/camunda-modeler).\r\n\r\n\r\n## Development Setup\r\n\r\nUse [npm](https://www.npmjs.com/), the [Node.js](https://nodejs.org/en/) package manager to download and install required dependencies:\r\n\r\n```sh\r\nnpm install\r\n```\r\n\r\nTo 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.\r\nAvailable 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.\r\n\r\nRe-start the app in order to recognize the newly linked plugin.\r\n\r\n\r\n## Building the Plugin\r\n\r\nYou may spawn the development setup to watch source files and re-build the client plugin on changes:\r\n\r\n```sh\r\nnpm run dev\r\n```\r\n\r\nGiven 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.\r\n\r\n\r\nTo prepare the plugin for release, executing all necessary steps, run:\r\n\r\n```sh\r\nnpm run all\r\n```\r\n\r\n\r\n## Before you Publish\r\n\r\n* [ ] 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).\r\n* [ ] Ensure you renamed the [bpmn-js extension](./client/bpmn-js-extension/index.js#L17) from `PLEASE_CHANGE_ME` to something unique\r\n* [ ] Ensure you've removed the menu and style folders as well as their references in `./index.js` if you do not need them\r\n\r\n\r\n### Badges to indicate typical plugin types\r\n\r\n| Badge | Markdown |\r\n|-|-|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_(Camunda_Platform_7)-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_(Camunda_Platform_7)-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_(Camunda_Platform_8)-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_(Camunda_Platform_8)-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_Moddle-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_Moddle-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_Moddle_(Camunda_Platform_7)-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_Moddle_(Camunda_Platform_7)-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_Moddle_(Camunda_Platform_8)-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_Moddle_(Camunda_Platform_8)-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-DMN-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-DMN-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-DMN_Moddle-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-DMN_Moddle-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-React-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-React-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-Styles-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-Styles-orange.svg)](#)`|\r\n|[![Plugin Type](https://img.shields.io/badge/Plugin_Type-Menu-orange.svg)](#)|`[![Plugin Type](https://img.shields.io/badge/Plugin_Type-Menu-orange.svg)](#)`|\r\n\r\n## Additional Resources\r\n\r\n* [List of existing plugins](https://github.com/camunda/camunda-modeler-plugins)\r\n* [Plugins documentation](https://docs.camunda.io/docs/components/modeler/desktop-modeler/plugins/)\r\n\r\n\r\n## Licence\r\n\r\nMIT\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcamunda%2Fcamunda-modeler-plugin-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcamunda%2Fcamunda-modeler-plugin-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcamunda%2Fcamunda-modeler-plugin-example/lists"}