From e3c50c6d643bb3f348a8aff4cbaf9931ea50687b Mon Sep 17 00:00:00 2001
From: wayn <1669738430@qq.com>
Date: Wed, 5 May 2021 01:04:57 +0800
Subject: [PATCH] =?UTF-8?q?refactor(=E5=95=86=E5=9F=8E):=20=E6=9B=B4?=
=?UTF-8?q?=E6=96=B0readme?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
readme.md | 146 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 141 insertions(+), 5 deletions(-)
diff --git a/readme.md b/readme.md
index 1185539..ed51218 100644
--- a/readme.md
+++ b/readme.md
@@ -1,8 +1,144 @@
-## waynboot的后端项目
+## waynboot-mall项目
-#### 2021年2月7日
+waynboot-mall是一套全部开源的微商城项目，包含一个运营后台、h5商城和后台接口。
+实现了一个商城所需的首页展示、商品分类、商品详情、sku详情、商品搜索、加入购物车、结算下单、订单状态流转、商品评论等一系列功能。
+技术上基于Springboot2.0，整合了Redis、RabbitMQ、ElasticSearch等常用中间件，
+贴近生产环境实际经验开发而来不断完善、优化、改进中。
-基本功能完成，首页、购物车、我的、下单
+[后台接口项目](https://github.com/wayn111/waynboot-mall)
+[运营后台项目](https://github.com/wayn111/waynboot-mall)
+[h5商城项目](https://github.com/wayn111/waynboot-mall)
-* 前端采用Vue、Element UI。
-* 后端采用Spring Boot、Spring Security、Redis & Jwt。
+## waynboot-mall接口项目
+
+1. 商城接口代码清晰、注释完善、模块拆分合理
+2. 使用Spring-Security进行访问权限控制
+3. 使用jwt进行接口授权验证
+4. ORM层使用Mybatis Plus提升开发效率
+5. 添加全局异常处理器，统一异常处理
+6. 添加https配置代码，支持https访问
+7. 集成七牛云存储配置，上传文件至七牛
+8. 集成常用邮箱配置，方便发送邮件
+9. 集成druid连接池，进行sql监控
+10. 集成swagger，管理接口文档
+11. 添加策略模式使用示例，优化首页金刚区跳转逻辑
+12. 拆分出通用的数据访问模块，统一redis & elastic配置与访问
+13. 使用elasticsearch-rest-high-level-client客户端对elasticsearch进行操作
+14. RabbitMQ生产者发送消息采用异步confirm模式，消费者消费消息时需手动确认
+15. ...
+
+## 文件目录
+```java
+|-- waynboot-admin-api // 运营后台api模块，提供后台项目api接口
+|-- waynboot-common // 通用模块，包含项目核心基础类
+|-- waynboot-data // 数据模块，通用中间件数据访问
+| |-- waynboot-data-redis // redis访问配置模块
+| |-- waynboot-data-elastic // elastic访问配置模块
+|-- waynboot-generator // 代码生成模块
+|-- waynboot-message-consumer // 消费者模块，处理订单消息和邮件消息
+|-- waynboot-message-core // 消费者核心模块，队列、交换机配置
+|-- waynboot-mobile-api // h5商城api模块，提供h5商城api接口
+|-- pom.xml // maven父项目依赖，定义子项目依赖版本
+|-- ...
+```
+
+## 开发部署
+```
+# 1. 克隆项目
+git clone git@github.com:wayn111/waynboot-mall.git
+
+# 2. 导入项目依赖
+将waynboot-mall目录用idea打开，导入maven依赖
+
+# 3. 安装Mysql、Redis、RabbitMQ、ElasticSearch到本地
+
+# 4. 导入sql文件
+在项目根目录下，找到`wayn_shop_*.sql`文件，新建mysql数据库wayn_shop，导入其中
+
+# 5. 修改Mysql、Redis、RabbitMQ、Elasticsearch连接配置
+修改`application-dev.yml`以及`application.yml`文件中数据连接配置享关信息
+
+# 6. 启动项目
+后台api：
+ 进入waynboot-admin-api子项目，找到AdminApplication文件，右键`run AdminApplication`，启动后台项目
+h5商城api:
+ 进入waynboot-mobile-api子项目，找到MobileApplication文件，右键`run MobileApplication`，启动h5商城项目
+```
+
+## 在线体验
+
+- 注册一个账号
+- 登陆
+
+演示地址：http://www.wayn.ltd
+
+## 演示图
+
+
+
+ 商城登陆 |
+ 商城注册 |
+
+
+ 商城首页 |
+ 商城搜索 |
+
+
+ 搜索结果展示 |
+ 金刚位跳转 |
+
+
+ 商品分类 |
+ 商品详情 |
+
+
+ 商品sku选择 |
+ 购物车查看 |
+
+
+ 确认下单 |
+ 选择支付方式 |
+
+
+ 商城我的页面 |
+ 我的订单列表 |
+
+
+ 添加商品评论 |
+ 查看商品评论 |
+
+
+ 后台登陆 |
+ 后台首页 |
+
+
+ 后台会员管理 |
+ 后台评论管理 |
+
+
+ 后台地址管理 |
+ 后台添加商品 |
+
+
+ 后台商品管理 |
+ 后台banner管理 |
+
+
+ 后台订单管理 |
+ 后台分类管理 |
+
+
+ 后台金刚区管理 |
+ 后台栏目管理 |
+
+
+
+
+## waynboot-mall交流群
+
+QQ群：
+
+## 感谢
+
+- [panda-mall](https://github.com/Ewall1106/vue-h5-template)
+- [vant-ui](https://github.com/youzan/vant)