Miranum Platform is an open source production ready process automation platform with a focus on human-task driven processes. Many components of this repository are based on the DigiWF project.
Content of this readme:
Miranum Platform is a solution for complex human task management workflows. With its unified Tasklist and JSON-based forms it represents a generic approach to task management, suitable for automating many different processes. Besides it provides all necessary components for task management purposes such as the Minio S3 storage as well as Keycloak.
Even though Miranum Platform was created out of a project in the public sector it can be used versatile in many different industries. Whenever you deal with human task management and need a centralized Tasklist, Miranum Platform is a possible choice.
Miranum Platform uses Camunda 7 as process engine with Polyflow for task handling.
In addition, system components such as Keycloak, Nginx, PostgreSQL and Minio are being used.
The latter tools are interchangeable but work best in the current version.
Components:
- Engine Tasklist Service: Includes Camunda Platform 7, Polyflow and the Miranum Tasklist Backend.
- Miranum Tasklist Webapp: Single-page application build with vue.js which renders the forms and tasklist.
- Miranum IDE: Collection of vs-code plugins to model bpmn processes, dmn decisions and forms using vuetify-jsonschema-forms.
- Schema Registry Service:
- Deployment Service:
- Keycloak:Open Source Identity and Access Management tool
- Nginx: Ingress controller
- PostgreSQL: Relational database
- Minio: MinIO is a High Performance Object Storage which is API compatible with Amazon S3 cloud storage service.
To get started with Miranum Platform please navigate to the platform-stack folder and follow the
instructions in the README.md. Once the infrastructure components have started you can run the
local run configuration. Make sure that you have performed a mvn clean build before doing so.
A more in depth miranum-stack-showcase can be found in our documentation.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. To collect, prioritise and work on issues in a collaborative fashion we have established some contribution guidelines as well as a GitHub project. Please make sure to read through these guidelines before starting with your contribution.
All changes have to be done in a separate Branch or Fork (if you are an external contributor). As soon as the changes are done please open a PR. A GitHub Action runs with every commit to a Branch and checks if the documentation can be built. If you create a new branch make sure to name it according to what it does (e.g. feat/xyz or fix/xyz). Please use semantic commit messages as described in here.
We are using simple emoji's to help convey intention and added meaning in code review comments. A little bit of emoji can go a long way when it comes to code reviews and make giving and receiving code review a little bit more enjoyable. We are following this guide by erikthedeveloper.
This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to info@miragon.io.
Distributed under the MIT License. See LICENSE file for more information.