Giter VIP home page Giter VIP logo

nitram509 / lib-bpmn-engine Goto Github PK

View Code? Open in Web Editor NEW
233.0 19.0 57.0 2.33 MB

A BPMN engine, meant to be embedded in Go applications with minimal hurdles, and a pleasant developer experience using it. This approach can increase transparency for non-developers.

Home Page: https://nitram509.github.io/lib-bpmn-engine/

License: MIT License

Go 100.00%
golang go bpmn bpmn2 bpmn-engine hacktoberfest workflow workflow-engine workflows workflow-engine-bpmn

lib-bpmn-engine's Introduction

lib-bpmn-engine

Build status

go test status codecov Documentation Status Go Report Card

Project status

  • still "beta" status - with the upcoming 0.3.0-final release, the beta status will end
  • not yet recommended to use in production
  • breaking API changes expected
  • contributors welcome

Documentation

Full documentation with examples:
https://nitram509.github.io/lib-bpmn-engine/

GoDoc:
https://pkg.go.dev/github.com/nitram509/lib-bpmn-engine/pkg/bpmn_engine

There's an experimental online playground https://nitram509.github.io/lib-bpmn-engine-js/ available, which leverages the great power of cross-compiling to WASM.

Requirements

Go v1.20+

I'm supporting the latest and second-latest version of Go, similar to how Go itself handles releases.

BPMN Modelling

All these examples are build with Camunda Modeler Community Edition. I would like to send a big "thank you", to Camunda for providing such tool.

Implementation notes

IDs (process definition, process instance, job, events, etc.)

This engine does use an implementation of Twitter's Snowflake algorithm which combines some advantages, like it's time based and can be sorted, and it's collision free to a very large extend. So you can rely on larger IDs were generated later in time, and they will not collide with IDs, generated on e.g. other nodes of your application in a multi-node installation.

The IDs are structured like this ...

+-----------------------------------------------------------+
| 41 Bit Timestamp |  10 Bit NodeID  |   12 Bit Sequence ID |
+-----------------------------------------------------------+

The NodeID is generated out of a hash-function which reads all environment variables. As a result, this approach allows 4096 unique IDs per node and per millisecond.

Development of this library and contribution

For development hints and notes, please check DEVELOPMENT.md

For information on contribution, please check CONTRIBUTING.md

Community fun: stargazers over time

Stargazers over time

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.