diff --git a/README.md b/README.md index 6ea799a..bf27a2a 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,28 @@ 唛盟旨在为企业开发业务系统提供一整套解决方案,唛盟具有高效率、低代码、功能丰富等特点。企业可以在唛盟工程之上,加入更多其它业务功能;也可以以唛盟作为模板,创建新的工程,用于开发其它业务。使用唛盟构建应用,您不用考虑多租户、登录、统一认证中心、权限、菜单管理、系统管理、公共组件、公共api、代码冗余、数据字典、图片库、文件库、智能表单、工作流、微服务互相调用、全局跟踪定位bug、多主键crud,复杂sql查询等各种问题,这些问题的解决方案都作为扩展功能内置唛盟工程中了。 💪给你一个使用唛盟的理由:代码大量减少、开发so easy、前后端MIT协议、全部开源、永久免费 + + +## 📢工程介绍 +>⚠️工程分类:主体工程、基础配套工程、高级配套工程、拓展应用工程、辅助开发工具四大类。 +> 主体工程:本系统业务工程,用于书写本系统相关的业务代码; +> 基础配套工程:业务工程运行所需的必要工程;如开发底座,系统管理相关功能包 +> 高级配套工程:高级应用,比如需要将业务工程接入oauth2环境、将业务工程发布到cloud环境,才需要下载安装高级配套工程 +> 拓展应用工程: 基于唛盟低代码平台拓展的应用工程,其后端可以单体发布,也可以以微服务方式发布,也可以打成jar被唛盟其它应用引入 +> 辅助开发工具:指开发用到的一些工具 + +>⚠️工程命名规范:业务名称+工程属性 +> 工程属性如下: +> -ui: 页面工程 +> -web: pc端运行的浏览器工程 +> -backend: 后端服务 +> -app: 安卓、ios等原生app工程 +> -uniapp: 基于uniapp开发的应用 +> -minapp: 小程序 +> -cloud: 微服务cloud环境 +> -oauth2: 统一认证中心 +> -bootstrap: 打包部署工程 + ### 唛盟主体工程 唛盟属于前后端严格分离的一套系统,分为前端工程、后端工程两部分 - [mdp-lcode-ui-web](https://gitee.com/maimengcloud/mdp-lcode-ui-web) @@ -35,26 +57,29 @@ - [mdp-lcode-backend](https://gitee.com/maimengcloud/mdp-lcode-backend) 唛盟的后端工程,java语言为主 -### 配套工程 -- [mdp-code-generator](https://gitee.com/maimengcloud/mdp-code-generator) 代码生成器 -生成代码两种方式, -一、使用代码生成器本地工程,好处是代码可以直接覆盖到本地业务工程,避免复制黏贴出错。 -二、如果不需要本地生成代码,也可以在低代码平台在线生成。[在线生成代码](https://maimengcloud.com/lcode/m1/#/mdp/lcode/gen) -- [mdp-sys-backend](https://gitee.com/maimengcloud/mdp-sys-backend) - 登陆、角色管理、权限管理、组织、人员、菜单、部门、元数据等管理功能的服务接口,默认打包合并到mdp-lcode-backend中,如果不涉及改动,无须关注该工程 - +### 基础配套工程 + - [mdp-core](https://gitee.com/maimengcloud/mdp-core) - 该工程作为所有后端的公共封装,不包含任何的业务功能,仅作为后端系统的技术底座,包含一些公共工具、服务类抽象、dao层抽象等。 - 默认打包进mdp-lcode-backend中,一般无须理会 + 该工程作为所有后端的公共封装,不包含任何的业务功能,仅作为后端系统的技术底座,包含一些公共工具、服务类抽象、dao层抽象等。 + +- [mdp-sys-backend](https://gitee.com/maimengcloud/mdp-sys-backend) + 该工程作为系统管理相关功能的后端服务(菜单管理、用户管理、部门、权限管理、登录、注册等) +### 高级配套工程 - [mdp-cloud-backend](https://gitee.com/maimengcloud/mdp-cloud-backend) 该工程作为spring cloud的扩展工程,如果需要将系统发布到spring cloud环境,需要下载该工程重新打包,不包含任何的业务功能,仅作为后端接入cloud环境使用 + - [mdp-oauth2-backend](https://gitee.com/maimengcloud/mdp-oauth2-backend) 该工程为统一认证中心,作为spring oauth2的扩展工程,如果需要将系统接入oauth2环境,需要下载该工程重新打包,该工程实现分布式单点登陆;支持微信、支付宝、短信、账户密码等多种登陆方式 +### 开发辅助工具 +- [mdp-code-generator](https://gitee.com/maimengcloud/mdp-code-generator) 代码生成器 + 生成代码两种方式, + 一、使用代码生成器本地工程,好处是代码可以直接覆盖到本地业务工程,避免复制黏贴出错。 + 二、如果不需要本地生成代码,也可以在低代码平台在线生成。[在线生成代码](https://maimengcloud.com/lcode/m1/#/mdp/lcode/gen) ->⚠️注意:企业可以单独使用mdp-lcode-ui-web作为前端,单独开发后端系统;也可以使用**唛盟团队** 配套开源的后端系统[mdp-lcode-backend](https://gitee.com/maimengcloud/mdp-lcode-backend)作为后端服务。 - +### 拓展应用工程[点我跳转到拓展工程列表](#jump_tzgc) +- 拓展应用工程: 基于唛盟低代码平台拓展的应用工程,其后端可以单体发布,也可以以微服务方式发布,也可以打成jar被唛盟其它应用引入 ## 😭 日常开发中,您是否有以下痛点? @@ -393,6 +418,21 @@ npm run dev return "lcode" } ``` + +#### 图片库、素材库、标签库 +内容相关接口默认打包进mdp-lcode,所以内容相关接口可以直接对接lcode即可,如果内容相关的服务使用独立的第三方开源工程,独立部署,比如直接使用 [mdp-arc-backend](https://gitee.com/maimengcloud/mdp-arc-backend),则更改[mdp_config.js中的getArcContext函数即可快速切换](src/api/mdp_pub/mdp_config.js) +- 对接mdp-arc-backend +```js + getArcContext:function(){ + return "arc" + } +``` +- 对接mdp-lcode-backend +```js + getOauth2LoginContext:function(){ + return "lcode" + } +``` ### 发布 ```bash # 构建测试环境 @@ -411,7 +451,7 @@ mdp 3.0 版本已经开始规划更新了,尽请期待新版本的诞生吧 升级前必看:[CHANGELOG.md](/docs/CHANGELOG.md) -## 🚀 基于mdp框架拓展的开源项目 +## 🚀 基于mdp框架拓展的开源项目 >⚠️ 注意:以下拓展的框架或者子系统,由mdp开源团队基于项目经验进行总结抽取,可用可不用,可以以jar包方式合并到现有工程进行发布,也可单独发布成单体应用、微服务应用 - 第三方支付框架,整合了微信支付、支付宝支付、paypal支付