Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mytang0/brook
Brook is an orchestration engine, supports microservices and in-app logic (embedded use) orchestration.
https://github.com/mytang0/brook
embedded flow-engine java microservice microservice-orchestration orchestration orchestration-engine orchestrator plugins serverless springboot workflow-engine workflows
Last synced: 12 days ago
JSON representation
Brook is an orchestration engine, supports microservices and in-app logic (embedded use) orchestration.
- Host: GitHub
- URL: https://github.com/mytang0/brook
- Owner: mytang0
- License: apache-2.0
- Created: 2024-02-06T03:01:25.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-06T06:58:15.000Z (7 months ago)
- Last Synced: 2024-10-04T16:14:55.812Z (about 2 months ago)
- Topics: embedded, flow-engine, java, microservice, microservice-orchestration, orchestration, orchestration-engine, orchestrator, plugins, serverless, springboot, workflow-engine, workflows
- Language: Java
- Homepage:
- Size: 363 KB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Brook
Brook is an orchestration engine, supports microservices and in-app logic (embedded use) orchestration. With the embedded mode, users can effortlessly build their own workflow orchestration engine.
## Getting started
In order to maximize the lightweight nature of the Brook engine, a deliberate separation is made between its core components (which depend solely on a few essential toolkits) and the middleware extensions using SPI (Service Provider Interface). Consequently, regardless of the application implementation framework, one can seamlessly rely on the engine JAR and initialize the relevant instances.
### Maven dependency
Specify the version appropriate for the project, see [releases](https://github.com/mytang0/brook/releases).
```xml
...
```
#### Not using Spring
```xml
xyz.mytang0.brook
>brook-engine
${brook.version}
```
#### Springboot (recommend)
```xml
xyz.mytang0.brook
>brook-spring-boot-starter
${brook.version}
```
### Demo
After cloning the repository, the demo is located in the brook-demo module.
The definition of the testing process is located at 'resources/META-INF/flows'.
## Contributing
Brook welcomes anyone that wants to help out in any way, whether that includes reporting problems, helping with documentation, or contributing code changes to fix bugs, add tests, or implement new features. You can report problems to request features in the [GitHub Issues](https://github.com/mytang0/brook/issues).
### Code Contribute
- Left comment under the issue that you want to take.
- Fork Brook project to your GitHub repositories.
- Clone and compile your Brook project.
```bash
git clone https://github.com/your_name/brook.git
cd brook
mvn clean install -DskipTests
```
- Check to a new branch and start your work.
```bash
git checkout -b my_feature
```
- Push your branch to your github.
```bash
git push origin my_feature
```
- Create a new PR to https://github.com/mytang0/brook/pulls .