{"id":15350760,"url":"https://github.com/mytang0/brook","last_synced_at":"2025-04-15T02:37:05.878Z","repository":{"id":221094242,"uuid":"753394501","full_name":"mytang0/brook","owner":"mytang0","description":"Brook is an orchestration engine, supports microservices and in-app logic (embedded use) orchestration.","archived":false,"fork":false,"pushed_at":"2025-02-27T07:01:50.000Z","size":433,"stargazers_count":13,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T15:05:09.876Z","etag":null,"topics":["embedded","flow-engine","java","microservice","microservice-orchestration","orchestration","orchestration-engine","orchestrator","plugins","serverless","springboot","workflow-engine","workflows"],"latest_commit_sha":null,"homepage":"https://mytang0.github.io/brook/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mytang0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-06T03:01:25.000Z","updated_at":"2025-02-27T07:01:54.000Z","dependencies_parsed_at":"2024-03-01T09:31:06.418Z","dependency_job_id":"9359c94e-a8d8-4d05-ae1f-a3bc98266c75","html_url":"https://github.com/mytang0/brook","commit_stats":{"total_commits":26,"total_committers":2,"mean_commits":13.0,"dds":"0.038461538461538436","last_synced_commit":"9389cf6e8956760f0a512a2791506cbf234e5baf"},"previous_names":["mytang0/brook"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mytang0%2Fbrook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mytang0%2Fbrook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mytang0%2Fbrook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mytang0%2Fbrook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mytang0","download_url":"https://codeload.github.com/mytang0/brook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248995102,"owners_count":21195497,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["embedded","flow-engine","java","microservice","microservice-orchestration","orchestration","orchestration-engine","orchestrator","plugins","serverless","springboot","workflow-engine","workflows"],"created_at":"2024-10-01T11:59:09.654Z","updated_at":"2025-04-15T02:37:05.867Z","avatar_url":"https://github.com/mytang0.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brook\n\nBrook 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.\n\n## Getting started\n\nIn 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.\n\n### Maven dependency\n\nSpecify the version appropriate for the project, see [Maven Central Repository](https://central.sonatype.com/search?q=g:xyz.mytang0.brook).\n```xml\n\u003cproperties\u003e\n    \u003cbrook.version\u003e...\u003c/brook.version\u003e\n\u003c/properties\u003e\n```\n\n#### Not using Spring\n\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003exyz.mytang0.brook\u003c/groupId\u003e\n        \u003cartifactId\u003e\u003ebrook-engine\u003c/artifactId\u003e\n        \u003cversion\u003e${brook.version}\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n#### Springboot (recommend)\n\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003exyz.mytang0.brook\u003c/groupId\u003e\n        \u003cartifactId\u003e\u003ebrook-spring-boot-starter\u003c/artifactId\u003e\n        \u003cversion\u003e${brook.version}\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n### Demo\n\nAfter cloning the repository, the demo is located in the brook-demo module.\nThe definition of the testing process is located at 'resources/META-INF/flows'.\n\n## Contributing\n\nBrook 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).\n\n### Code Contribute\n\n- Left comment under the issue that you want to take.\n- Fork Brook project to your GitHub repositories.\n- Clone and compile your Brook project.\n```bash\ngit clone https://github.com/your_name/brook.git\ncd brook\nmvn clean install -DskipTests\n```\n- Check to a new branch and start your work.\n```bash\ngit checkout -b my_feature\n```\n- Push your branch to your github.\n```bash\ngit push origin my_feature\n```\n- Create a new PR to https://github.com/mytang0/brook/pulls .\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmytang0%2Fbrook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmytang0%2Fbrook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmytang0%2Fbrook/lists"}