diff --git a/README.md b/README.md index 9e665105e9..655e2e4831 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,61 @@ -## 华炎魔方概览 -[English](https://github.com/steedos/steedos-platform/blob/1.22/README_en.md) / [中文](https://github.com/steedos/steedos-platform) +## Steedos Platform -华炎魔方是一套可视化建模、描述式编程的低代码开发平台，只需点击鼠标，就能轻松便捷地创建智能化、移动化的企业应用程序。 +[中文](https://github.com/steedos/steedos-platform) / [English](https://github.com/steedos/steedos-platform/blob/1.22/README_en.md) -
- 文档 - · 报告错误 - · 讨论 +Steedos Platform is a low code development platform with visual modeling and descriptive programming. You can easily create intelligent and mobile enterprise applications by clicking the mouse. + +
+ Docs + · Report a bug + · Discussions
-

![华炎魔方项目对象界面](https://steedos.github.io/assets/github/platform/cn/Project_object.jpg) +## Features +- **Visual Modeling**: Based on metadata driven, Steedos Platform abstracts the traditional business requirements realized by code into configurable metadata. By simply clicking the tag to modify the configuration item, the vast majority of business requirements can be realized, and the code can be written if necessary. -## 华炎魔方功能 +- **Define User Interface**: With Steedos Platform, you can quickly build list view page layout, reports, and dashboards to truly realize user-defined interface. -- **可视化建模**：华炎魔方基于元数据驱动，把传统通过代码实现的业务需求抽象为可配置的元数据 ，只需点击⿏标修改配置项，就能实现绝⼤多数业务需求 ，必要时仍可编写代码。 -- **定义用户界面**：使用华炎魔方，你可以快速构建列表视页面布局、报表、仪表盘，真正实现界面自定义。 -- **配置验证规则**：在华炎魔⽅中，⽤户可以为每⼀个对象创建验证规则。验证规则主要⽤于验证该对象的数据是否符合特定的规则。当⽤户对于对象的某个字段的更改不符合⽤户创建的验证规则时，华炎魔⽅会拒绝保存⽤户的输⼊。 -- **公式引擎**：华炎魔方内置了与Excel同级别的公式引擎，可通过配置公式实现自动化条件判断、数据计算、引用关联表的数据，或是汇总子表中的相关数据。 -- **工作流规则**：通过设定工作流规则，记录在满⾜指定条件时，华炎魔方将会执⾏规则的⾃动化操作，让业务在无人值守的情况下自动运转，驱动效率提升。 -- **自动化操作**：通过设定自动化操作，可以在特定条件下自动化创建和更新记录、发送邮件、短信或系统内通知，也可以自动调用第三方系统的接口。 -- **批准过程**：系统内置了流程设计、流程运行、管理维护、统计分析与流程优化等各类工具，帮助企业快速部署、有效监控并持续优化业务审批过程。 -- **可视化报表工具**：使用华炎魔方的报表引擎，您可以快速配置统计图表，包括数据列表、分组报表、数据透视图、柱状图、饼图等，方便查看、分析和决策。 -- **高级业务逻辑开发**：华炎魔方提供了代码开发的入口，开发人员通过编写代码，实现特定条件下的自动运行、截停、回滚等高级业务逻辑。或是开发与第三方系统的接口。 -- **开源、可定制**：华炎魔方是开源的。这会让您充满信心，华炎魔方将永远存在。您还可以将其源码Fork下来，并根据需要进行更改。 +- **Configure Validation Rules**: In Steedos Platform, users can create validation rules for each object. Validation rules are mainly used to verify whether the data of the object conforms to specific rules. When a user changes a field of an object that does not conform to the validation rules created by the user, Hua will refuse to save the user's input. -## 安装部署 +- **Formula Engine**: Steedos Platform has built-in formula engine of the same level as Excel, which can realize automatic condition judgment, data calculation, reference of data in associated table or summary of relevant data in sub table by configuring formula. -本项目是华炎魔方的内核源码，我们会定期编译并发布为 [npm package](https://www.npmjs.com/package/steedos-server)，只需在项目中引入相关的包，既可启用华炎魔方的各项功能。 +- **Workflow Rules**: By setting workflow rules and recording that when the specified conditions are met, Steedos Platform will implement the automatic operation of the rules, so that the business can operate automatically without being on duty and drive efficiency improvement. -具体如何安装部署华炎魔方，请参考[官网安装部署文档](https://www.steedos.com/help/deploy) +- **Automatic Operation**: By setting the automatic operation, you can automatically create and update records, send e-mail, SMS or notification in the system under specific conditions, and can also call the interface of the third-party system automatically. -## 学习华炎魔方 +- **Approval Process**: The system has built-in various tools, such as process design, process operation, management and maintenance, statistical analysis and process optimization, to help enterprises quickly deploy, effectively monitor and continuously optimize the business approval process. -您还可以根据华炎魔方快速构建应用程序的视频教程进行操作。 +- **Visual Report Tool**: With the report engine of Steedos Platform , you can quickly configure statistical charts, including data list, group report, PivotChart, bar chart, pie chart, etc., for easy viewing, analysis and decision-making. -- [视频演示](https://www.steedos.com/videos/) -- [使用入门](https://www.steedos.com/help/user/) -- [设置和维护华炎魔方](https://www.steedos.com/help/admin/) -- [开发人员](https://www.steedos.com/developer/) +- **Advanced Business logic Development**: Steedos Platform provides an entry point for code development. Developers can realize high-level business logic such as automatic operation, stop and rollback under specific conditions by writing code. Or develop interfaces with third-party systems. +- **Open Source, Customizable**: Steedos Platform is open source. This will make you confident that Steedos Platform will exist forever. You can also fork the source code down and make changes as needed. -## 为华炎魔方做贡献 +## Installation and Deployment -从上报BUG到提出改善建议，每一个贡献都值得赞赏和欢迎。如果您打算动手修改代码来修正BUG或实现某个新功能，请先创建一个 [ISSUE](https://github.com/steedos/steedos-platform/issues)，这样我们可以确保您的工作没有白费。 +This project is the kernel source code of Steedos Platform . We will compile and release it as [NPM package](https://www.npmjs.com/package/steedos-server) regularly ,By introducing relevant packages into the project, all the functions of Steedos Platform can be enabled. +For details on how to install and deploySteedos Platform , please refer to the [Official Website Installation and Deployment Document](https://www.steedos.com/help/deploy/) + +## Learn Steedos Platform + +You can also follow a video tutorial on how to quickly build an app for Steedos. + +- [Video Demonstration](https://www.steedos.com/videos) +- [Getting Started](https://www.steedos.com/help/user) +- [Set Up and Maintain Steedos Platform](https://www.npmjs.com/package/steedos-server) +- [Developers](https://www.steedos.com/videos) + +## Contribute to Steedos Platform + +From reporting bugs to proposing improvement suggestions, every contribution is worthy of appreciation and welcome. If you are going to modify the code to fix a bug or implement a new function, please create an issue first, so that we can ensure that your work is not wasted. ## Licence -华炎魔方开源版基于MIT协议，内置华炎魔方十大引擎，完全免费。基于华炎魔方开发的解决方案，可以单独定价销售。 +Steedos Platform open source version based on MIT protocol, built-in Steedos Platform en engines, completely free. The solution based on Steedos Platform can be sold at a separate price. -## 保持联系 +## Keep in Contact -如果您有任何疑问或想与其他华炎魔方用户交谈，请[点击进入讨论](https://steedos.github.io/steedos/steedos-platform/discussions)或扫码添加以下联系方式与我们联系。 - -#### 开发人员微信群 - -![开发者微信交流群](https://steedos.github.io/assets/github/platform/cn/QR_wechat_developers.jpg) - -#### 商务咨询 - -![商务咨询](https://steedos.github.io/assets/github/platform/cn/Business_Consulting.jpg) - -#### 微信公众号 - -![微信公众号](https://steedos.github.io/assets/github/platform/cn/Public_Number.jpg) +If you have any questions or want to talk to other users of Steedos Platform , please jump to GitHub for discussion [Click to Discuss](https://github.com/steedos/steedos-platform/discussions) or [Join me on Slack-it's a faster,simpler way to work](https://join.slack.com/t/steedos/shared_invite/zt-jq7eupr9-cgKrUOyWb1zymniRzhH4jg). diff --git a/README_cn.md b/README_cn.md new file mode 100644 index 0000000000..72acd570c8 --- /dev/null +++ b/README_cn.md @@ -0,0 +1,68 @@ +## 华炎魔方概览 + +[English](https://github.com/steedos/steedos-platform/blob/1.22/README_en.md) / [中文](https://github.com/steedos/steedos-platform) + +华炎魔方是一套可视化建模、描述式编程的低代码开发平台，只需点击鼠标，就能轻松便捷地创建智能化、移动化的企业应用程序。 + +
+ 文档 + · 报告错误 + · 讨论 +
+

+ +![华炎魔方项目对象界面](https://steedos.github.io/assets/github/platform/cn/Project_object.jpg) + + +## 华炎魔方功能 + +- **可视化建模**：华炎魔方基于元数据驱动，把传统通过代码实现的业务需求抽象为可配置的元数据 ，只需点击⿏标修改配置项，就能实现绝⼤多数业务需求 ，必要时仍可编写代码。 +- **定义用户界面**：使用华炎魔方，你可以快速构建列表视页面布局、报表、仪表盘，真正实现界面自定义。 +- **配置验证规则**：在华炎魔⽅中，⽤户可以为每⼀个对象创建验证规则。验证规则主要⽤于验证该对象的数据是否符合特定的规则。当⽤户对于对象的某个字段的更改不符合⽤户创建的验证规则时，华炎魔⽅会拒绝保存⽤户的输⼊。 +- **公式引擎**：华炎魔方内置了与Excel同级别的公式引擎，可通过配置公式实现自动化条件判断、数据计算、引用关联表的数据，或是汇总子表中的相关数据。 +- **工作流规则**：通过设定工作流规则，记录在满⾜指定条件时，华炎魔方将会执⾏规则的⾃动化操作，让业务在无人值守的情况下自动运转，驱动效率提升。 +- **自动化操作**：通过设定自动化操作，可以在特定条件下自动化创建和更新记录、发送邮件、短信或系统内通知，也可以自动调用第三方系统的接口。 +- **批准过程**：系统内置了流程设计、流程运行、管理维护、统计分析与流程优化等各类工具，帮助企业快速部署、有效监控并持续优化业务审批过程。 +- **可视化报表工具**：使用华炎魔方的报表引擎，您可以快速配置统计图表，包括数据列表、分组报表、数据透视图、柱状图、饼图等，方便查看、分析和决策。 +- **高级业务逻辑开发**：华炎魔方提供了代码开发的入口，开发人员通过编写代码，实现特定条件下的自动运行、截停、回滚等高级业务逻辑。或是开发与第三方系统的接口。 +- **开源、可定制**：华炎魔方是开源的。这会让您充满信心，华炎魔方将永远存在。您还可以将其源码Fork下来，并根据需要进行更改。 + +## 安装部署 + +本项目是华炎魔方的内核源码，我们会定期编译并发布为 [npm package](https://www.npmjs.com/package/steedos-server)，只需在项目中引入相关的包，既可启用华炎魔方的各项功能。 + +具体如何安装部署华炎魔方，请参考[官网安装部署文档](https://www.steedos.com/help/deploy) + +## 学习华炎魔方 + +您还可以根据华炎魔方快速构建应用程序的视频教程进行操作。 + +- [视频演示](https://www.steedos.com/videos/) +- [使用入门](https://www.steedos.com/help/user/) +- [设置和维护华炎魔方](https://www.steedos.com/help/admin/) +- [开发人员](https://www.steedos.com/developer/) + + +## 为华炎魔方做贡献 + +从上报BUG到提出改善建议，每一个贡献都值得赞赏和欢迎。如果您打算动手修改代码来修正BUG或实现某个新功能，请先创建一个 [ISSUE](https://github.com/steedos/steedos-platform/issues)，这样我们可以确保您的工作没有白费。 + +## Licence + +华炎魔方开源版基于MIT协议，内置华炎魔方十大引擎，完全免费。基于华炎魔方开发的解决方案，可以单独定价销售。 + +## 保持联系 + +如果您有任何疑问或想与其他华炎魔方用户交谈，请[点击进入讨论](https://steedos.github.io/steedos/steedos-platform/discussions)或扫码添加以下联系方式与我们联系。 + +#### 开发人员微信群 + +![开发者微信交流群](https://steedos.github.io/assets/github/platform/cn/QR_wechat_developers.jpg) + +#### 商务咨询 + +![商务咨询](https://steedos.github.io/assets/github/platform/cn/Business_Consulting.jpg) + +#### 微信公众号 + +![微信公众号](https://www.steedos.com/assets/github/platform/cn/Public_Number.jpg) \ No newline at end of file diff --git a/README_en.md b/README_en.md deleted file mode 100644 index b23cc01f8d..0000000000 --- a/README_en.md +++ /dev/null @@ -1,60 +0,0 @@ -## Steedos Platform - -[中文](https://github.com/steedos/steedos-platform) / [English](https://github.com/steedos/steedos-platform/blob/1.22/README_en.md) - -Steedos Platform is a low code development platform with visual modeling and descriptive programming. You can easily create intelligent and mobile enterprise applications by clicking the mouse. - -
- Docs - · Report a bug - · Discussions -
- -![华炎魔方项目对象界面](https://steedos.github.io/assets/github/platform/cn/Project_object.jpg) -## Features - -- **Visual Modeling**: Based on metadata driven, Steedos Platform abstracts the traditional business requirements realized by code into configurable metadata. By simply clicking the tag to modify the configuration item, the vast majority of business requirements can be realized, and the code can be written if necessary. - -- **Define User Interface**: With Steedos Platform, you can quickly build list view page layout, reports, and dashboards to truly realize user-defined interface. - -- **Configure Validation Rules**: In Steedos Platform, users can create validation rules for each object. Validation rules are mainly used to verify whether the data of the object conforms to specific rules. When a user changes a field of an object that does not conform to the validation rules created by the user, Hua will refuse to save the user's input. - -- **Formula Engine**: Steedos Platform has built-in formula engine of the same level as Excel, which can realize automatic condition judgment, data calculation, reference of data in associated table or summary of relevant data in sub table by configuring formula. - -- **Workflow Rules**: By setting workflow rules and recording that when the specified conditions are met, Steedos Platform will implement the automatic operation of the rules, so that the business can operate automatically without being on duty and drive efficiency improvement. - -- **Automatic Operation**: By setting the automatic operation, you can automatically create and update records, send e-mail, SMS or notification in the system under specific conditions, and can also call the interface of the third-party system automatically. - -- **Approval Process**: The system has built-in various tools, such as process design, process operation, management and maintenance, statistical analysis and process optimization, to help enterprises quickly deploy, effectively monitor and continuously optimize the business approval process. - -- **Visual Report Tool**: With the report engine of Steedos Platform , you can quickly configure statistical charts, including data list, group report, PivotChart, bar chart, pie chart, etc., for easy viewing, analysis and decision-making. - -- **Advanced Business logic Development**: Steedos Platform provides an entry point for code development. Developers can realize high-level business logic such as automatic operation, stop and rollback under specific conditions by writing code. Or develop interfaces with third-party systems. - -- **Open Source, Customizable**: Steedos Platform is open source. This will make you confident that Steedos Platform will exist forever. You can also fork the source code down and make changes as needed. - -## Installation and Deployment - -This project is the kernel source code of Steedos Platform . We will compile and release it as [NPM package](https://www.npmjs.com/package/steedos-server) regularly ,By introducing relevant packages into the project, all the functions of Steedos Platform can be enabled. -For details on how to install and deploySteedos Platform , please refer to the [Official Website Installation and Deployment Document](https://www.steedos.com/help/deploy/) - -## Learn Steedos Platform - -You can also follow a video tutorial on how to quickly build an app for Steedos. - -- [Video Demonstration](https://www.steedos.com/videos) -- [Getting Started](https://www.steedos.com/help/user) -- [Set Up and Maintain Steedos Platform](https://www.npmjs.com/package/steedos-server) -- [Developers](https://www.steedos.com/videos) - -## Contribute to Steedos Platform - -From reporting bugs to proposing improvement suggestions, every contribution is worthy of appreciation and welcome. If you are going to modify the code to fix a bug or implement a new function, please create an issue first, so that we can ensure that your work is not wasted. - -## Licence - -Steedos Platform open source version based on MIT protocol, built-in Steedos Platform en engines, completely free. The solution based on Steedos Platform can be sold at a separate price. - -## Keep in Contact - -If you have any questions or want to talk to other users of Steedos Platform , please jump to GitHub for discussion [Click to Discuss](https://github.com/steedos/steedos-platform/discussions) or [Join me on Slack-it's a faster,simpler way to work](https://join.slack.com/t/steedos/shared_invite/zt-jq7eupr9-cgKrUOyWb1zymniRzhH4jg). diff --git a/README_old.md b/README_old.md deleted file mode 100644 index 07342034f2..0000000000 --- a/README_old.md +++ /dev/null @@ -1,103 +0,0 @@ -# 华炎魔方低代码开发平台 - -华炎魔方是开源低代码开发工具，基于商业智能和模型驱动，可以按照业务需求，轻松便捷地创建智能化、移动化、个性化的应用程序。 - -华炎魔方致力于打造 Salesforce Platform 的开源替代方案。 - -## 什么是华炎魔方？ - -- [华炎魔方平台概览](https://www.steedos.com/platform/?from=github) -- [视频演示](https://www.steedos.com/videos/) -- [安装部署](https://www.steedos.com/developer/deploy) -- [开发向导](https://www.steedos.com/developer/) -- [用户手册](https://www.steedos.com/help/user/) -- [管理员手册](https://www.steedos.com/help/admin/) - -## 开发进度 - -### 数据建模 - -- [x] 字段 -- [x] 关系 -- [x] 列表视图 -- [x] 页面布局 -- [x] 操作按钮 -- [ ] 记录类型 - -### 模型驱动界面 - -- [x] 仪表盘 -- [x] 报表 -- [x] 列表视图 -- [x] 日历视图 -- [x] 记录查看 -- [x] 全局查找 -- [ ] Chatter -- [ ] 看板视图 - -### 低代码开发 - -- [x] 触发器 -- [x] 服务端API -- [x] 操作按钮 -- [x] React 自定义页面 - -### 流程自动化 - -- [x] 审批王 -- [x] 批准过程 -- [ ] 进程生成器 -- [ ] 屏幕流 - -### 系统集成 - -- [x] 单点登录 接口 -- [x] ODATA API 接口 -- [x] GraphQL API 接口 -- [x] Webhooks - -### 移动化 - -- [x] 手机客户端 -- [x] 手机版列表视图 -- [x] 手机版页面布局 -- [x] 消息推送 -- [x] 拍照上传 - -### 用户管理 - -- [x] 组织 -- [x] 分部 -- [x] 部门 -- [x] 人员 -- [x] 角色 -- [x] 简档 -- [x] 权限集 -- [ ] 队列 - -### 权限控制 - -- [x] 应用程序权限 -- [x] 对象权限 -- [x] 字段权限 -- [x] 按钮权限 -- [x] 列表视图权限 -- [x] 共享规则 - -### 标准业务对象 - -- [x] 客户 -- [x] 联系人 -- [x] 公告 -- [x] 任务 -- [x] 日程 -- [x] 附件 -- [x] 知识库 - -## 微信群 - -对于华炎魔方有疑问？？欢迎加入华炎魔方开发者微信群。 - -![联系我们](https://wework.qpic.cn/wwpic/245123_3nYlxE6LT9qSfLA_1599620554/0) - -请微信扫描以上二维码，并长按选择识别图中二维码。