doc(README.md):完善项目说明文档,添加切换到自己环境的步骤

This commit is contained in:
hxrui 2021-02-07 16:53:49 +08:00
parent 933ab99701
commit dc8691e55f
3 changed files with 40 additions and 19 deletions

View File

@ -11,7 +11,7 @@
## 项目特色
- 项目使用都是最新主流的**开源**框架,无过度自定义封装逻辑,易理解上手和方便扩展
- 项目使用都是最新主流的**开源**框架,无过度自定义封装逻辑,易理解上手和方便扩展
- 基于Spring Boot 2.4、Spring Cloud 2020 & Alibaba 一站式微服务解决方案快速开发分布式服务
@ -92,12 +92,13 @@ youlai-mall
| 后端技术 | 版本号
| -------------------- | -------------------- |
| SpringBoot|2.4.2
| Spring Cloud|2020.0.0
| Spring Cloud Alibaba| 2.2.4.RELEASE
| Spring Cloud|2020.0.1
| Spring Cloud Alibaba| 2.2.5.RELEASE
| MyBatis-Plus|3.4.0
| Lombok |1.18.12
| Knife4j | 2.0.4
| MinIO | 2.0.4
| Lombok |1.18.18
| Hutool |5.5.8
| Knife4j | 2.0.5
| MinIO | 7.1.0
| 后台前端 | 版本号 | 微信小程序 | 版本号| APP | 版本号
|---- | ---- | ---- | ---- |---- | ----
@ -110,18 +111,40 @@ youlai-mall
项目依赖环境MySQL8、Redis、MinIO、Nacos默认均使用`有来技术`云环境,项目启动极其方便。
**项目启动步骤:**
1. **启动本地Nacos服务:**
1. **启动`Nacos`服务**
IDEA下方工具栏点击Terminal终端命令行执行`cd youlai-registry/nacos/bin`命令切换到Nacos的启动脚本文件夹下然后执行`startup -m standalone`命令启动Nacos服务
2. **系统基础服务启动完整的实现OAuth2统一认证鉴权的流程:**
2. **启动平台基础服务**
分别启动`youlai-gateway`、`youlai-auth`、 `youlai-admin`模块,
启动类分别对应的是GatewayApplication、AuthApplication以及`youlai-admin`的子模块`admin-biz`下的的AdminApplication类至此完成整个项目的启动
3. 如需商城服务启动对应模块的子模块biz的启动类即可。
**切换到自己的环境步骤:**
**提示:** 云环境是无条件的提供给大家,但千万不要改动云环境的数据和配置,因为会导致整个项目无法运行,考虑下开发人员和其他小伙伴,手下留情。
1. **安装环境**
安装`MySQL8`、`Redis`、`MinIO`,其中`MinIO`按需安装
2. **创建数据库**
- 新建平台数据库,执行项目`document/sql`下的SQL脚本完成数据库创建基础sql脚本为`youlai.sql`,商城脚本为`mall-*`,商城数据库按需创建
- 创建`Nacos`数据库,执行脚本`youlai-registry/nacos/conf/nacos-mysql.sql`完成`Nacos`数据库的初始化
3. **Nacos配置**
- 修改`Nacos`数据源,进入配置`youlai-registry/nacos/conf/application.properties`将数据源修改为自己的环境连接
- 导入`Nacos`配置,在启动`Nacos`服务进入控制台导入`document/nacos/DEFAULT_GROUP.zip`配置然后分别进入各个微服务配置修改Redis、MySQL、MinIO以及微服务的注册IP
**提示:**
1. 如需商城服务启动对应模块的子模块biz的启动类即可。
2. 云环境是无条件的提供给大家,但千万不要改动云环境的数据和配置,因为会导致整个项目无法运行,考虑下开发人员和其他小伙伴,手下留情。
### 2. 后台前端`youlai-mall-admin`启动
@ -139,7 +162,6 @@ youlai-mall
4. `Hbuilder X`替换项目AppID成自己的点击`manifest.json`文件->微信小程序配置
5. `Hbuilder X`工具栏点击 `运行`->`运行到小程序模拟器`->`微信开发者工具`
## 项目文档
> 后台微服务

14
pom.xml
View File

@ -32,16 +32,16 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<lombok.version>1.18.12</lombok.version>
<spring-cloud.version>2020.0.0</spring-cloud.version>
<spring-cloud-alibaba.version>2.2.4.RELEASE</spring-cloud-alibaba.version>
<hutool.version>5.5.7</hutool.version>
<lombok.version>1.18.18</lombok.version>
<spring-cloud.version>2020.0.1</spring-cloud.version>
<spring-cloud-alibaba.version>2.2.5.RELEASE</spring-cloud-alibaba.version>
<hutool.version>5.5.8</hutool.version>
<mysql.version>8.0.19</mysql.version>
<druid.version>1.1.23</druid.version>
<druid.version>1.2.4</druid.version>
<mybatis-plus.version>3.4.2</mybatis-plus.version>
<minio.version>7.1.0</minio.version>
<knife4j.version>2.0.4</knife4j.version>
<weixin-java-miniapp.version>4.0.3.B</weixin-java-miniapp.version>
<knife4j.version>2.0.5</knife4j.version>
<weixin-java-miniapp.version>4.0.4.B</weixin-java-miniapp.version>
<hibernate-validator.version>6.0.13.Final</hibernate-validator.version>
<seata.version>1.4.1</seata.version>
</properties>

View File

@ -12,7 +12,6 @@ import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.Collections;
@Configuration