Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 3.06 KB

README.md

File metadata and controls

40 lines (33 loc) · 3.06 KB

Documentation

This is the documentation for the Quantum Workflow Modeler. It provides all necessary information to understand, install, and extend this project.

Table of Contents

This documentation contains the following sections:

A guide for developers to set up this project for further development.

A guide on how to integrate the Quantum Workflow Modeler component into your web application.

A guide on how to integrate features from the QuantME Transformation Framework into the modeler.

Description of the testing setup, including the GitHub actions used to run them. This section also contains a guide on how to write unit tests for plugins, allowing new developers to test their modeling extensions and their integration in a structured and automated manner.

Modeler Documentation

Documentation of the Quantum Workflow Modeler. It contains information about the interfaces and components it provides, as well as the already integrated Plugin documentation. The content of this section is divided into the following subsections:

  1. Editor Component
    1. Plugin Handler
    2. UI extensions
    3. Workflow Event Handler
    4. Configurations
    5. Extended Popup Menu
  2. Extensions
    1. DataFlow Plugin
    2. QuantME Plugin
    3. PlanQK Plugin
    4. QHAna Plugin

bpmn-js Documentation

Useful information and documentation on how to use and extend the bpmn-js modeler and its components. The content is based on personal experience, the bpmn-js walkthrough, and the source code of the bpmn-js Modeler. This documentation may help you extend the bpmn-js modeler to write your own custom modeling extensions. It consists of the following sections: