Skip to content

Latest commit

 

History

History
69 lines (54 loc) · 2.26 KB

README.md

File metadata and controls

69 lines (54 loc) · 2.26 KB
Raw

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.

<properties>
    <dubbo.version>...</dubbo.version>
</properties>

Not using Spring

<dependencies>
    <dependency>
        <groupId>xyz.mytang0.brook</groupId>
        <artifactId>>brook-engine</artifactId>
        <version>${brook.version}</version>
    </dependency>
</dependencies>

Springboot (recommend)

<dependencies>
    <dependency>
        <groupId>xyz.mytang0.brook</groupId>
        <artifactId>>brook-spring-boot-starter</artifactId>
        <version>${brook.version}</version>
    </dependency>
</dependencies>

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.

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.
git clone https://github.com/your_name/brook.git
cd brook
mvn clean install -DskipTests
  • Check to a new branch and start your work.
git checkout -b my_feature
  • Push your branch to your github.
git push origin my_feature