docs(README.md): 项目说明文档排版优化

This commit is contained in:
郝先瑞 2022-02-16 05:21:24 +00:00 committed by Gitee
parent 42b3394f62
commit 6b37bac27b

View File

@ -18,21 +18,25 @@
</p>
<p align="center">
    <strong>开源地址:</strong> <a target="_blank" href='https://github.com/hxrui'>Github</a> | <a target="_blank" href='https://gitee.com/haoxr'>Gitee</a> | <a target="_blank" href='https://gitcode.net/youlai'>GitCode</a>
</p>
<p align="center">
    <strong>博客主页:</strong><a target="_blank" href="https://www.cnblogs.com/haoxianrui/"> https://www.cnblogs.com/haoxianrui</a>
</p>
<p align="center">
    <strong>开发者文档:</strong><a target="_blank" href="http://youlaitech.gitee.io/youlai-mall">http://youlaitech.gitee.io/youlai-mall</a>
</p>
## 🈶 项目介绍
@ -55,7 +59,7 @@
| | 地址 |
| --- | --- |
| ------------- | --------------------------------------------------- |
| 管理前端 Vue3 | [www.youlai.tech](http://www.youlai.tech) |
| 管理前端 Vue2 | [www.youlai.tech:9527](http://www.youlai.tech:9527) |
| H5 移动端 | [www.youlai.tech:81](http://www.youlai.tech:9527) |
@ -65,7 +69,7 @@
| 「App」Spring Security OAuth2 手机短信验证码模式 | 「小程序」Spring Security OAuth2 微信授权模式 |
| ------------------------------------------------------------ |----------------------------------------------------------- |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| <img src="https://gitee.com/haoxr/image/raw/master/default/smscode%20(1).gif" width="100%" height="400px"/> | <img src="https://gitee.com/haoxr/image/raw/master/default/wechatlogin.gif" width="100%" height="400px"/> |
| **「管理前端」Spring Security OAuth2 密码模式** | **「管理前端」Spring Security OAuth2 验证码模式** |
| <img src="https://gitee.com/haoxr/image/raw/master/default/password.gif" width="100%" height="400px"/> | <img src="https://gitee.com/haoxr/image/raw/master/default/captcha.gif" width="100%" height="400px"/> |
@ -75,7 +79,7 @@
| | Gitee | Github | GitCode |
|---|---|---|---|
| ---------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 开源组织 | [有来开源组织](https://gitee.com/youlaiorg) | [有来开源组织](https://github.com/youlaitech) | [有来开源组织](https://gitcode.net/youlai) |
| 后端 | [youlai-mall](https://gitee.com/youlaiorg/youlai-mall) | [youlai-mall](https://github.com/youlaitech/youlai-mall) | [youlai-mall](https://gitcode.net/youlai/youlai-mall) |
| 管理前端 | [mall-admin-web](https://gitee.com/youlaiorg/mall-admin-web) | [mall-admin-web](https://github.com/youlaitech/mall-admin-web) | [mall-admin-web](https://github.com/youlaitech/mall-admin-web) |
@ -122,6 +126,9 @@
1. **中间件安装(🔴必装 ⚪可选)**
> 为了避免数据和线上环境冲突MySQL 和 Redis 必装,不安装可默认使用有来线上环境
- 🔴MySQL 安装
- 🔴Redis 安装
- ⚪RabbitMQ
@ -131,35 +138,30 @@
2. **数据库创建和数据初始化**
- **系统数据库**
进入 `doc/sql` 目录 根据 MySQL 版本选择对应的脚本;
进入 `doc/sql` 目录 根据 MySQL 版本选择对应的脚本;
先执行 `database.sql` 完成数据库的创建;
再执行 `youlai.sql` 、`mall_*.sql` 完成数据表的创建和数据初始化。
先执行 `database.sql` 完成数据库的创建;
再执行 `youlai.sql` 、`mall_*.sql` 完成数据表的创建和数据初始化。
- **Nacos 数据库**
创建名为 nacos 的数据库;
执行 `middleware/nacos/conf/nacos-mysql.sql` 脚本完成 Nacos 数据库初始化。
创建 Nacos 数据库,名为 `nacos`
执行 `middleware/nacos/conf/nacos-mysql.sql` 脚本完成 Nacos 数据库初始化。
3. **Nacos 配置和启动**
a. **Nacos 配置持久化至 MySQL**
> Nacos 默认配置持久化到内嵌的Derby数据库开发无特殊情况可使用默认配置如需持久化配置到MySQL完成下面配置修改即可。
1. **Nacos 配置持久化至 MySQL**
进入项目的 `middleware/nacos/conf/application.properties` 文件修改 Nacos 配置的数据连接,需要修改配置如下:
进入 `middleware/nacos/conf/application.properties` 文件修改 Nacos 配置的数据连接,需要修改配置如下:
```properties
spring.datasource.platform=mysql
db.num=1
@ -167,46 +169,40 @@
db.user.0=root
db.password.0=123456
```
b. **启动Nacos**
IDEA 打开命令行终端 Terminal输入 `cd middleware/nacos/bin` 切换到 Nacos 的 bin 目录,执行 `startup -m standalone` 启动 Nacos 服务。
2. **启动Nacos**
IDEA 打开命令行终端 Terminal输入 `cd middleware/nacos/bin` 切换到 Nacos 的 bin 目录,执行 `startup -m standalone` 启动 Nacos 服务。
3. **导入Nacos配置**
打开浏览器,地址栏输入 Nacos 控制台的地址 [ http://localhost:8848/nacos]( http://localhost:8848/nacos)
c. **导入Nacos配置**
输入用户名/密码nacos/nacos
打开浏览器,地址栏输入 Nacos 管控台的地址 [ http://localhost:8848/nacos]( http://localhost:8848/nacos)
进入控制台,点击左侧菜单 `配置管理``配置列表` 进入列表页面,点击 `导入配置` 选择项目中的 `doc/nacos/DEFAULT_GROUP.zip` 文件 。
4. **修改Nacos配置**
输入用户名/密码nacos/nacos
进入管控台,点击左侧菜单 `配置管理``配置列表` 进入列表页面,点击 `导入配置` 选择项目中的 `doc/nacos/DEFAULT_GROUP.zip` 文件
d. **修改Nacos配置**
进入共享配置 `youlai-common.yaml` ,修改 MySQL、Redis、RabbitMQ等中间件信息为您自己本地环境默认为有来云环境。
在 Nacos 控制台配置列表选择共享配置 `youlai-common.yaml` 进行编辑,修改 MySQL、Redis、RabbitMQ等中间件信息为您自己本地环境默认有来 线上环境。
4. **服务启动**
- 进入 `youlai-gateway` 模块的启动类 GatewayApplication 启动网关;
进入 `youlai-gateway` 模块的启动类 GatewayApplication 启动网关;
- 进入 `youlai-auth` 模块的启动类 AuthApplication 启动认证授权中心;
- 进入 `youlai-admin``admin-boot` 模块的启动类 AdminApplication 启动系统服务;
- 至此已完成基础服务的启动,商城服务按需启动,启动方式和 `youlai-admin` 一致;
- 访问接口文档地址测试 [http://localhost:9999/doc.html
进入 `youlai-auth` 模块的启动类 AuthApplication 启动认证授权中心;
进入 `youlai-admin``admin-boot` 模块的启动类 AdminApplication 启动系统服务;
至此已完成基础服务的启动,商城服务按需启动,启动方式和 `youlai-admin` 一致。
5. **启动测试**
访问接口文档地址测试 [http://localhost:9999/doc.html](http://localhost:9999/doc.html)
### 🗁 管理前端启动
@ -249,6 +245,7 @@
</p>
- Github
@ -257,6 +254,7 @@
</p>
## 💬 联系信息
@ -264,4 +262,4 @@
| ![](https://gitee.com/haoxr/image/raw/master/hxr.jpg) | ![](https://gitee.com/haoxr/image/raw/master/default/jialin.jpg) | ![](https://gitee.com/haoxr/image/raw/master/default/ba695a5e70410a066b7052c5dc9db5c.jpg) |
|---|---|---|
| ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |