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

This commit is contained in:
郝先瑞 2022-02-01 00:31:22 +08:00
parent 4b9effb1ca
commit 99be0f987d

View File

@ -2,14 +2,41 @@
![](https://img.shields.io/badge/youlai--mall-v2.0.0-blue) ![](https://img.shields.io/badge/SpringBoot-2.6.3-brightgreen.svg) ![](https://img.shields.io/badge/SpringCloud-2021-green.svg) [![](https://img.shields.io/github/stars/youlaitech/youlai-mall.svg?style=social&label=Stars)](https://github.com/youlaitech/youlai-mall) [![](https://gitee.com/youlaitech/youlai-mall/badge/star.svg)](https://gitee.com/youlaiorg/youlai-mall) [![](https://img.shields.io/badge/Author-有来开源组织-orange.svg)](https://gitee.com/youlaiorg) [![](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://gitee.com/youlaitech/youlai-mall/blob/master/LICENSE)
[在线预览](http://www.youlai.tech/) | [Gitee 仓库](https://gitee.com/youlaiorg) | [Github 仓库](https://github.com/youlaitech) | [博客主页](https://www.cnblogs.com/haoxianrui/) | [官方文档](http://youlaitech.gitee.io/youlai-mall/)
[Gitee 仓库](https://gitee.com/youlaiorg) | [Github 仓库](https://github.com/youlaitech) | [博客主页](https://www.cnblogs.com/haoxianrui/) | [官方文档](http://youlaitech.gitee.io/youlai-mall/)
# 📚️ 项目简介
# 📚️ 项目介绍
### 🗀 项目简介
[youlai-mall](https://gitee.com/haoxr) 是基于Spring Boot 2.6、Spring Cloud 2021 & Alibaba 2021、Vue3、Element-Plus、uni-app等主流技术栈构建的一整套全栈开源商城项目 涉及 [后端微服务](https://gitee.com/youlaitech/youlai-mall) 、 [前端管理](https://gitee.com/youlaitech/youlai-mall-admin) 、 [微信小程序](https://gitee.com/youlaitech/youlai-mall-weapp) 和 [APP应用](https://gitee.com/youlaitech/youlai-mall-weapp) 等多端的开发。
### 🗀 在线预览
- 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)
- 小程序: 加我微信申请体验
### 🗀 项目特色
- 项目使用皆是当前主流的技术栈,无过度自定义封装,易理解学习和二次扩展;
- SpringBoot 2.6、SpringCloud 2021 & Alibaba 2021 一站式微服务开箱即用的解决方案;
- Spring Security OAuth2 、 Spring Cloud Gateway 、 JWT 统一认证鉴权逻辑和常用授权模式扩展;
- 移动端采用终极跨平台解决方案 uni-app 一套代码编译iOS、Android、H5和小程序等多个平台
- Jenkins、Docker、K8s实现微服务持续集成与交付(CI/CD)。
### 🗀 预览截图
| 【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"/> |
# ⛺ 源码地址
| 名称 | Gitee | Github |
|---|---|---|
@ -22,7 +49,6 @@
# 🚤 项目启动
### 🗀 后端启动
> `极速启动` 是方便快速启动查看效果的启动方式其中的数据库和Redis等中间件使用的是有来提供的云环境切勿修改数据有时间条件建议`本地启动`。
@ -31,7 +57,7 @@
1. **启动 Nacos**
IDEA 打开命令行终端 Terminal输入 `cd middleware/nacos/bin` 切换到Nacos的bin目录执行 `startup -m standalone` 启动 Nacos 服务。
IDEA 打开命令行终端 Terminal输入 `cd middleware/nacos/bin` 切换到 Nacos bin 目录,执行 `startup -m standalone` 启动 Nacos 服务。
2. **导入Nacos配置**
@ -84,12 +110,44 @@
3. **Nacos 配置和启动**
- 进入 `middleware/nacos/conf/application.properties` 文件修改 Nacos 配置的数据连接
1. **Nacos 配置持久化至 MySQL**
> Nacos 默认配置持久化到内嵌的Derby数据库开发无特殊情况可使用默认配置如需持久化配置到MySQL完成下面配置修改即可。
5. [ ] 123231
进入 `middleware/nacos/conf/application.properties` 文件修改 Nacos 配置的数据连接,需要修改配置如下:
```properties
spring.datasource.platform=mysql
db.num=1
db.url.0=jdbc:mysql://localhost:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
db.user.0=root
db.password.0=123456
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)
输入用户名/密码nacos/nacos
进入管控台,点击左侧菜单 `配置管理``配置列表` 进入列表页面,点击 `导入配置` 选择项目中的 `doc/nacos/DEFAULT_GROUP.zip` 文件 。
4. **服务启动**
进入 `youlai-gateway` 模块的启动类 GatewayApplication 启动网关;
进入 `youlai-auth` 模块的启动类 AuthApplication 启动认证授权中心;
进入 `youlai-admin``admin-boot` 模块的启动类 AdminApplication 启动系统服务;
至此已完成基础服务的启动,商城服务按需启动,启动方式和 `youlai-admin` 一致。
5. **启动测试**
访问接口文档地址测试 [http://localhost:9999/doc.html](http://localhost:9999/doc.html)
### 🗀 管理前端启动