Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nitram509/lib-bpmn-engine
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.
https://github.com/nitram509/lib-bpmn-engine
bpmn bpmn-engine bpmn2 go golang hacktoberfest workflow workflow-engine workflow-engine-bpmn workflows
Last synced: 2 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/nitram509/lib-bpmn-engine
- Owner: nitram509
- License: mit
- Created: 2021-10-01T15:09:22.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-23T10:44:22.000Z (2 months ago)
- Last Synced: 2024-07-23T12:50:10.720Z (2 months ago)
- Topics: bpmn, bpmn-engine, bpmn2, go, golang, hacktoberfest, workflow, workflow-engine, workflow-engine-bpmn, workflows
- Language: Go
- Homepage: https://nitram509.github.io/lib-bpmn-engine/
- Size: 2.31 MB
- Stars: 249
- Watchers: 19
- Forks: 60
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: docs/supported-elements.md
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
README
# lib-bpmn-engine
## Build status
[](https://github.com/nitram509/lib-bpmn-engine/actions/workflows/go-test.yml)
[](https://codecov.io/gh/nitram509/lib-bpmn-engine)
[](https://nitram509-lib-bpmn-engine.readthedocs-hosted.com/en/latest/?badge=latest)
[](https://goreportcard.com/report/github.com/nitram509/lib-bpmn-engine)
## 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](https://camunda.com/de/download/modeler/).
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](https://en.wikipedia.org/wiki/Snowflake_ID)
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](./DEVELOPMENT.md)
For information on contribution, please check [CONTRIBUTING.md](./CONTRIBUTING.md)
## Community fun: stargazers over time
[](https://starchart.cc/nitram509/lib-bpmn-engine)