Skip to content

Engine neutral framework to build integrations. Simplifying the complexity process automation comes with.

License

Notifications You must be signed in to change notification settings

Miragon/miranum

Repository files navigation

Contributors Forks Stargazers Issues MIT License C7


Logo

Simplifying the complexity of process automation.
Report Bug · Request Feature

About The Project

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:

Use-Cases

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.

Platform Overview

Miranum Platform uses Camunda 7 as process engine and provides a set of components to build a complete process automation application. The platform is designed to be modular and can be used as a whole or in parts. Each component is build as a hexagonal module that enables the user to replace the default implementation with a custom one.

Components:

  • Engine-Core includes Camunda Platform 7 and providers core APIs for process execution.
  • Engine-Task contains task management apis.
  • Engine-User contains a user management abstraction layer.

Get Started

Checkout the examples in the examples folder to see how to use Miranum Platform and create your own process application using miranum connect.

Engage with the Miranum team

If you have any questions or need support, feel free to reach out to us via email (info@miragon.io). We are here to help you, especially if you are considering introducing Miranum in your organization.

For inquiries and professional support, please contact us at: info@miragon.io

Contributing

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.

PRs for every change

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.

Code reviews

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.

Code of Conduct

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.

License

Distributed under the MIT License. See LICENSE file for more information.

(back to top)

About

Engine neutral framework to build integrations. Simplifying the complexity process automation comes with.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages