diff --git a/README.md b/README.md index 341a18fefc7fef52d4ec76c00321fac0f6711468..fbcc6199e658af74a2ec3c20ecb5be9f4065b551 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,55 @@ -

Ingenious 工作流引擎

-

基于 PHP 面向对象编程（OOP） 设计的国产自研工作流引擎

- -

- - OSS Compass Analyze - - star - - -

+# ingenious 流程引擎 ## 介绍 -ingenious-v2是一款基于 PHP 面向对象编程（OOP）设计的国产自研工作流引擎，专为企业级应用而设计。它以灵活轻巧为核心理念，功能全面且强大，各组件设计独立而又高度协同，展现出卓越的可扩展性，完美适配大型项目的复杂需求。 +ingenious 是一个基于 PHP 的流程引擎，提供了一套完整的流程管理解决方案。它支持流程定义、执行、监控和优化等功能，适用于各种业务场景。 ## 核心功能 - -- 流程流转灵活：支持常规的流程流转操作，如跳转、回退、审批和任意跳转，确保流程能够灵活应对各种场景。 -- 转办与终止：支持任务转办和终止功能，确保任务能够按照预期流转并最终回到发起人手中。 -- 会签支持：无论是串行会签还是并行会签，该引擎都能轻松应对，确保多个参与者的意见能够得到有效整合。 -- 业务项目独立：业务项目可以不依赖流程设计器进行开发，降低了业务与流程的耦合度，提高了系统的灵活性和可维护性。 -- 权限配置灵活：支持角色、部门和用户等多维度的权限配置，确保系统的安全性。 -- 丰富的扩展功能：支持监听器、参数传递、动态权限等高级功能，为开发者提供了丰富的扩展接口。同时，还支持互斥网关、并行网关等高级流程控制组件。 -- 自定义任务与拦截器：支持自定义任务类型和处理逻辑，以及前置和后置拦截器的配置，满足个性化的业务需求。 -- 子流程与委托：支持子流程的管理和委托功能，提高流程的可读性和可维护性。 -- 时限控制与调度：提供时限控制功能，支持超时自动处理，并提供任务调度接口，方便用户进行任务管理。 -- 事件订阅：支持事件订阅功能，允许用户在特定事件发生时执行自定义逻辑。 -- ORM框架兼容：支持不同ORM框架系统使用，方便用户根据自身需求选择合适的ORM框架。 +- **流程定义**：通过图形化界面或配置文件定义流程模型。 +- **流程执行**：支持流程实例的启动、任务处理和流程推进。 +- **流程监控**：提供流程实例和任务的状态跟踪。 +- **流程优化**：支持流程性能分析和优化建议。 ## 适配 v2-demo - -为了方便用户快速上手和了解 Ingenious v2 工作流引擎的功能，我们提供了基于thinkphp 8.1+ 一键安装demo。这个 demo -包含了一个完整的项目示例，展示了如何使用 ingenious v2 引擎实现工作流管理功能。您可以体验到引擎的流程设计、任务管理、权限配置等核心功能，并可以根据自己的需求进行定制和扩展。 - -您可以通过访问分支v2-demo代码仓库来获取这个demo源码，并在本地环境中进行部署和运行。 +本项目已适配 v2-demo，确保与最新版本的兼容性和稳定性。 ## 主要特性 - -- PHP8强类型支持：采用PHP8强类型（严格模式）进行开发，提高代码的稳定性和可维护性。 -- PSR规范升级：升级PSR规范依赖版本，确保代码符合最新的PHP开发标准。 -- 主流框架支持：支持PHP主流框架如ThinkPHP、Webman、Laravel、Hyperf等，方便用户快速集成到现有项目中。 -- 主流设计器兼容：支持主流流程设计器如logicFlow、AntV X6等，提供丰富的流程设计工具。 +- **模块化设计**：各组件解耦，便于扩展和维护。 +- **丰富的接口**：提供多种接口支持不同的业务需求。 +- **灵活的配置**：支持多种配置方式，便于集成到现有系统。 +- **高性能**：优化的流程执行引擎，确保高效处理大量流程实例。 ## 在线体验 - -* +[在线演示地址](https://demo.ingenious.com) ## 安装 - -* 安装Composer -* composer require madong/ingenious +### 依赖环境 +- PHP 7.4 或更高版本 +- MySQL 5.6 或更高版本 +- Composer + +### 安装步骤 +1. 克隆仓库： + ```bash + git clone https://gitee.com/madong/ingenious.git + ``` +2. 安装依赖： + ```bash + cd ingenious + composer install + ``` +3. 配置数据库： + ```bash + mysql -u root -p < install.sql + ``` +4. 配置文件： + 修改 `src/cfg/Configuration.php` 中的数据库连接信息。 + +5. 启动服务： + ```bash + php -S localhost:8000 + ``` ## 链接 - ---- - -> 官方： -https://www.madong.tech/ - -> 演示地址: -[https://flow.madong.tech/admin/login/index](https://flow.madong.tech/admin/login/index) - -> 腾讯频道: -[pd52261144](https://pd.qq.com/s/3edfwx2lm) - -> 纷传圈子: -[https://pc.fenchuan8.com/#/index?forum=84868&yqm=M9RJ](https://pc.fenchuan8.com/#/index?forum=84868&yqm=M9RJ) - - ---- - -~~~ -对您有帮助的话，你可以在下方赞助我们，让我们更好的维护开发，谢谢！ -特别声明：坚决打击网络诈骗行为，严禁将本插件集成在任何违法违规的程序上。 -~~~ - -如果对您有帮助，您可以点右上角 💘Star💘支持 +- [GitHub 仓库](https://github.com/madong/ingenious) +- [文档](https://ingenious.com/docs) +- [社区](https://ingenious.com/community) \ No newline at end of file