From 7708c7fab96a31e28cd3fd684bb2c581fcb445d1 Mon Sep 17 00:00:00 2001
From: Richie <280645618@qq.com>
Date: Wed, 17 Jul 2024 22:06:56 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README-ERP.md | 214 ++++++++++++++++++++++++++++++++++++++++++++++++
README-OMS.md | 219 ++++++++++++++++++++++++++++++++++++++++++++++++++
README-SCM.md | 153 +++++++++++++++++++++++++++++++++++
README.md | 34 ++++++++
4 files changed, 620 insertions(+)
create mode 100644 README-ERP.md
create mode 100644 README-OMS.md
create mode 100644 README-SCM.md
diff --git a/README-ERP.md b/README-ERP.md
new file mode 100644
index 00000000..839f3db8
--- /dev/null
+++ b/README-ERP.md
@@ -0,0 +1,214 @@
+# 启航电商ERP系统
+## 一、系统介绍
+启航电商ERP系统是一套为电商企业构建的一套简单、实用、现代化UI的覆盖全流程的电商系统，本项目采用Java SpringBoot3+Vue2前后端分离开发。 该系统建立在企业使用基础上删减了一些个性化功能，基本满足电商业务处理。
+
+启航电商ERP系统主要场景是：订单发货、售后处理与库存出入库联动，支持货品先入先出。出入库都有详细的记录，适合电商企业业务处理和财务对账，可以很方便地二次开发加入财务对账模块或者通过接口与财务系统进行对接。
+
+**支持供应商一件代发和仓库发货两种发货方式**
+
+### 1.1 功能介绍
+
++ 采购管理：采购下单、采购入库、采购退货出库等。
+
++ 订单管理：支持手动添加订单，**支持网店订单API拉取**，目前支持的平台有：淘宝、京东、拼多多、抖店、视频号小店，后续计划继续支持快手、小红书等。
+
++ 发货管理：支持分配给仓库发货和分配给供应商发货，**后续计划引入OMS系统的电子面单打印功能**。
+
++ 售后管理：支持手动添加售后单，**支持网店售后API拉取**。售后处理反馈（订单拦截、订单补发、订单退货、订单换货、订单退款等）。
+
++ 库存管理：仓库管理，仓库出入库明细管理。
+
++ 店铺管理：网店管理、网店参数设置、网店商品关联（**支持网店商品API拉取**）。
+
++ 商品管理：商品管理、商品属性管理、商品分类管理。
+
++ 系统设置：登录用户设置、系统设置等。
+
+
+
+
+
+### 1.2 主要技术及组件
++ Java17
++ SpringBoot3
++ Redis
++ Nacos
++ MyBatis-Plus
++ MySQL8
+
+### 1.3 开发计划
++ [ ] 引入OMS系统中的电子面单打印，实现打单发货一体。
++ [ ] 对接更多电商平台API
+ + [x] 淘宝
+ + [x] 京东
+ + [x] 拼多多
+ + [x] 抖店
+ + [x] 微信视频号
+ + [ ] 快手小店
+ + [ ] 小红书
+
+
+
+## 二、主要流程
+**启航电商ERP可以说是我多年电商行业从业经验积累的成果。**
+
+公司从2019年踏入电商以来，一直都是由我组建和带领一帮技术人员从零开始建设了一套完全适应公司业务需要的电商ERP系统，包括WMS仓库系统、OMS订单处理系统、财务系统、直播运营系统等子系统组成。核心模块包括：采购模块、出入库模块、订单发货模块、电子面单打印模块等。
+
+公司ERP对接了批批网、1688、蘑菇街、淘宝、拼多多、抖店、快手小店平台。
+
+
+### 2.1 采购流程
++ 采购单管理：管理采购流程，包括供应商选择、采购单生成、采购单审核等。
++ 采购物流管理：跟踪采购订单物流信息。
++ 采购账单管理
++ 供应商管理：管理供应商信息
+
+
+**采购流程**
+
+```mermaid
+graph LR
+A[创建采购订单] -->B(审核)
+ B --> C[供应商确认]
+ C --> E[供应商发货]
+ E --> F1(生成物流信息)
+ F1 --> G1[确认收货]
+ G1 --> G3[生成入库单]
+ G3 --> G4(入库)
+ G1 --> G2[生成采购账单]
+ G4 --> H(完成)
+ G2 --> H
+
+```
+
+### 2.2 发货流程
+
+
+**订单发货流程**
+```mermaid
+graph TD
+A[网店拉取订单] -->B(审核订单)
+ B --> C[订单库]
+ C --> C1[备货清单中展示需要发货的订单]
+ C1 --> D[仓库发货-生成出库单]
+ C1 --> E[分配供应商发货]
+ D --> F(拣货出库)
+ F --> F1[出库]
+ E --> H(打包发货-记录包裹信息)
+ F1 --> H
+ H --> G(推送发货信息-记录包裹信息-生成发货费用-物流费和代发费)
+ G --> I(完成)
+```
+
+**仓库发货流程**
+```mermaid
+graph TD
+A[查询备货清单] -->B(生成拣货单)
+ B --> C[拣货出库]
+ C --> E(减库存)
+ E --> F[打包发货]
+ F --> F1(记录包裹信息)
+ F1 --> G(填写物流信息)
+ G --> G1[同步发货状态]
+ G1 --> H(完成)
+ G --> G2[生成物流费用账单]
+ G2 --> H
+
+```
+
+### 2.3 售后处理流程
+
+**退货退款流程**
+```mermaid
+graph LR
+A[录入退款退货] -->B(仅退款)
+ B --> H(完成)
+ A --> D(退货退款)
+ D --> E[仓库收货]
+ E --> F[退货入库处理]
+ F --> H
+```
+
+**售后流程**
+```mermaid
+graph LR
+A[录入售后] -->B(补发商品)
+ B --> H[仓库出库-记录]
+ A --> D(换货)
+ D --> E[仓库收货-入库]
+ E --> H
+ H --> F(完成)
+```
+
+
+**订单拦截**
+```mermaid
+graph LR
+A[录入拦截] -->B(通知仓库)
+ B --> H1[未发货-直接入库]
+ B --> D(已发货)
+ D --> E[通知消费者拒收]
+ E --> H[消费者拒收]
+ H --> C[退回入库]
+ C --> F(退款给消费者)
+ F --> G[完成]
+ H1 --> G
+```
+
+
+
+## 三、部署说明
+
+**项目采用SpringBoot+vue2开发。具体使用方法如下**
+
+#### 3.1 配置启动MySQL
+
++ 创建数据库`qihang-erp`
+ + 1、导入数据库结构：sql脚本`docs\qihang-erp.sql`
+ + 2、导入系统数据：sql脚本`docs\qihang-erp-sys.sql`
+
+#### 3.2 启动Redis
+项目开发采用Redis7
+
+#### 3.3 启动后端api
+
++ 修改`api`项目中的配置文件`application.yml`配置`Mysql`相关配置。
+
++ 启动项目
+
+
+#### 3.4 启动前端 `vue`
++ `npm install`
++ `npm run dev`
++ 打包`npm run build:prod`
++ 访问web
+ + 访问地址：`http://localhost`
+ + 登录名：`admin`
+ + 登录密码：`admin123`
+
+
+
+
+
+## 四、期待您的支持
+
+**感谢大家的关注与支持！希望利用本人从事电商10余年的经验帮助到大家提升工作效率！**
+
+💖 如果觉得有用记得点 Star⭐
+
+
+### 4.1 关注公众号
+
+更多服务，请关注作者微信公众号：qihangerp168
+
+
+
+
+💖 欢迎一起交流！
+
+### 4.2 捐助项目
+作者为兼职做开源,平时还需要工作,如果帮到了您可以请作者吃个盒饭
+
+
+
+
diff --git a/README-OMS.md b/README-OMS.md
new file mode 100644
index 00000000..70ad5616
--- /dev/null
+++ b/README-OMS.md
@@ -0,0 +1,219 @@
+# 启航电商OMS订单处理系统
+
+## 一、系统介绍
+启航电商OMS订单处理系统是一套为电商企业构建的一套简单、实用、现代化UI的订单业务处理系统，本项目采用Java SpringBoot3+SpringCloud+Vue2开发。
+
+启航电商OMS订单处理系统主要场景是：订单发货、售后处理、电子面单打印（订单打印）。该系统服务店铺订单业务处理全流程，可使用接口与ERP系统进行对接。
+
+**目前已接入：淘宝、京东、拼多多、抖店、视频号**，后续会继续接入快手小店、小红书等。
+
+主体功能包括：
++ 订单管理：店铺订单同步、管理。
++ 发货管理：**电子面单打印**、发货记录、物流跟踪等。
++ 售后管理：店铺售后同步、售后处理（补发、换货、退货处理）等。
++ 店铺管理：店铺管理、店铺商品管理（拉取店铺商品、ERP关联）。
+
+
+
+
+
+
+## 二、关键流程
+
+### 2.1 关联商品SKU
+```mermaid
+graph TD
+ A[添加ERP商品SKU信息] -->B(拉取店铺商品)
+ B --> C[店铺商品SKU关联ERP商品SKU]
+ C --> E(完成)
+```
+
+
+### 2.2 处理订单（发货）
+```mermaid
+graph TD
+ A[店铺订单拉取] -->B(店铺订单推送到OMS订单中心)
+ B --> C(后台任务:订单商品数据自动关联ERP系统SKU)
+ C --> D[接口推送/手动推送:将订单推送给ERP系统-外部系统]
+ D --> E[接收/手动录入ERP系统发货单号]
+ E --> F[变更OMS订单状态 - 将发货信息推送给平台店铺]
+ F --> G(完成)
+```
+
+
+### 2.3 处理售后
+
+```mermaid
+graph TD
+ A[店铺退款拉取] -->B(店铺退款推送到OMS售后中心)
+ B --> D[接口推送/手动推送:将订单推送给ERP系统-外部系统]
+ D --> E[接收/手动录入ERP系统处理售后结果:补发/换货/退货]
+ E --> F[变更OMS售后状态 - 将售后结果信息推送给平台店铺]
+ F --> G(完成)
+```
+
+
+
+## 三、系统架构
+### 1、开发环境级组件
+#### 1.1 开发环境
++ Jdk：17
++ Nodejs：v16.20.0
+
+#### 1.2 项目组件
+##### 后端核心组件
++ SpringBoot：3.0.2
+ + spring-boot-starter-security
++ SpringCloudAlibaba：2022.0.0.0
+ + Nacos
+ + SpringCloud Gateway
+ + spring-cloud-starter-loadbalancer
+
+##### 前端框架及组件
++ vue2
++ element
+
+#### 1.3、存储及中间件
+
++ MySQL8
++ Redis：7.x
++ Kafka
++ Nacos：2.2.0（配置中心、注册中心）
++ Sentinel（分布式流量治理组件）
+
+ `java -Dserver.port=8888 -Dcsp.sentinel.dashboard.server=localhost:8888 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard.jar`
+
+
+### 2、项目结构
+#### 2.1 core
+项目公共模块包括：
+
++ `common`:公共类型
+
++ `security`:公共权限验证模块
+
+#### 2.2 api
+网关项目，负责微服务接口转发，前端统一通过网关调用其他微服务接口；
+
+采用`gateway`进行api分发，引入Sentinel进行流量治理。
+
+#### 2.3 sys-api
+项目系统微服务，主要功能包括：
+
++ 用户
++ 菜单
+
+#### 2.4 oms-api
+oms主功能微服务，主要功能包括：
+
++ 队列消息处理（订单消息、退款消息）
++ 订单接口
++ 退款接口
++ 店铺接口
+
+#### 2.5 open-api
+各开放平台微服务
+##### 2.5.1 tao-api
+淘宝开放平台接口api
+
+##### 2.5.2 jd-api
+京东开放平台接口api
+
+##### 2.5.3 dou-api
+抖店开放平台接口api
+
+##### 2.5.4 pdd-api
+拼多多开放平台接口api
+
+##### 2.5.5 wei-api
+微信视频号小店开放平台接口api
+
+
+##### 2.5.6 kwai-api
+快手小店开放平台接口api
+
+
+### 3、运行说明
+#### 3.1、启动环境
+
+1. 启动MySQL8
+2. 启动Redis7
+3. 启动Sentinel1.8.7控制台
+4. 启动Nacos2.2.0
+5. 启动Kafka
+
+#### 3.2、导入数据库
++ 创建数据库`qihang-erp`
+ + 1、导入数据库结构：sql脚本`docs\qihang-erp.sql`
+ + 2、导入系统数据：sql脚本`docs\qihang-erp-sys.sql`
+
+#### 3.3、启动服务(项目)
+1. 启动开放平台业务微服务（tao-api、jd-api、dou-api、pdd-api等平台接口api微服务）
+2. 启动sys-api、oms-api微服务
+3. 启动微服务网关（api）
+
+#### 3.4、运行前端
++ Nodejs版本：v16.20.0
++ 进入`vue`文件夹
++ 运行`npm install`
++ 运行`npm run dev`
++ 浏览网页`http://localhost`
+
+### 4、项目部署
+
+#### 4.1 打包
+
+##### 后端打包
+`mvn clean package`
+
+##### 前端打包
+`pnpm run build:prod`
+
+
+#### 4.2 Nginx配置
+```
+# 上传文件至远程服务器
+将打包生成在 `dist` 目录下的文件拷贝至 `/usr/share/nginx/html` 目录
+
+# nginx.cofig 配置
+server {
+ listen 80;
+ server_name localhost;
+ location / {
+ root /usr/share/nginx/html;
+ index index.html index.htm;
+ }
+ # 反向代理配置
+ location /prod-api/ {
+ proxy_pass http://127.0.0.1:8080/; # 替换成你的后端网关API地址
+ }
+}
+```
+
+## 四、期待您的支持
+
+**感谢大家的关注与支持！希望利用本人从事电商10余年的经验帮助到大家提升工作效率！**
+
+💖 如果觉得有用记得点 Star⭐
+
+
+### 4.1 关注公众号
+
+更多服务，请关注作者微信公众号：qihangerp168
+
+
+
+
+💖 欢迎一起交流！
+
+### 4.2 捐助项目
+作者为兼职做开源,平时还需要工作,如果帮到了您可以请作者吃个盒饭
+
+
+
+
+
+
+
+
+
diff --git a/README-SCM.md b/README-SCM.md
new file mode 100644
index 00000000..0a8fca10
--- /dev/null
+++ b/README-SCM.md
@@ -0,0 +1,153 @@
+# 启航电商SCM供应链分销代发系统
+
+## 一、项目概述
+
+启航电商SCM供应链分销代发系统是为电商供应链端开发的一套供应商分销代发业务系统，主体业务流程是：分销终端从各平台店铺导入(拉取)订单、厂家(供应商)从系统后台打单发货。
+
+系统由2个子系统组成：厂家(供应商)分销代发系统和分销终端订单管理系统。
+
++ `厂家(供应商)分销代发系统`主要功能：
+ + 商品发布、价格设置
+ + 订单打印
+ + 订单发货
+ + 售后处理
+ + 代发应收账单
+
++ `分销终端订单管理系统`功能有：
+ + 店铺管理
+ + 店铺订单同步、
+ + 订单分发给供应商
+ + 店铺售后管理
+ + 店铺商品上下架管理
+ + 代发应付账单
+
+本系统后端采用Dubbo微服务架构，前端采用Vue2+Element。
+
+系统使用者有：厂家(供应商)、分销终端(各店铺经营者)。
+
+**系统主干流程：**
+
+```mermaid
+graph TB
+A[供应商发布商品] -->B(设置代发价格)
+ B --> E[分销终端上架]
+ E --> C[分销终端-拉取店铺订单]
+ C --> D[分销终端-分配发货供应商]
+ D --> F[供应商接收订单]
+ F --> G[供应商打印订单]
+ G --> H[供应商发货]
+ H --> J[生成代发账单]
+ H --> I[发货状态同步到分销终端的平台店铺]
+ I --> K(完成)
+ J --> K
+
+```
+
+
+## 二、项目说明
+**本项目后端采用Dubbo微服务开发，前端采用vue+element**
+
+### 2.1 主要版本
++ 后端：
+ + `Java`: 17
+ + `SpringBoot`: 3.0.13
+ + `Dubbo`：3.2.12
++ 前端：
+ + `vue2`
+ + `elementUI`
+
+### 2.2 存储及中间件
++ `MySQL`:数据库,版本8.x。
++ `minio文`:文件存储,用于图片存储。
++ `Redis`:在线用户信息、缓存。
++ `Nacos`:版本2.2.0以上，配置中心、注册中心。
+
+### 2.3 项目结构
+#### 2.3.1 api-scm
+`厂家(供应商)分销代发系统`接口项目，端口8080，采用dubbo调用其他微服务。
+
+#### 2.3.2 api-oms
+`分销终端订单管理系统`接口项目，端口8081，采用dubbo调用其他微服务。
+
+#### 2.3.3 interfaces
+微服务接口类库（包括domain、service-interface）
+
+#### 2.3.4 service
+微服务实现层，service-impl
+
+#### 2.3.5 common
+公共类库
+
+#### 2.3.6 vue-scm
+`厂家(供应商)分销代发系统`前端Vue项目，调用`api-scm`项目接口
+
+#### 2.3.7 vue-oms
+`分销终端订单管理系统`前端Vue项目，调用`api-oms`项目接口
+
+## 三、如何使用？
+### 3.1、开发环境配置
++ MySQL数据库创建
+ + 运行MySQL脚本`docs\sql\qihangerp-scm.sql`导入数据到主库`qihangerp-scm`
+
++ 启动nacos
+ + 启动
+
+ **一般情况下：下载nacos2.3.2解压之后直接运行：**
+
+ `startup.cmd -m standalone`
+
+ + 添加Nacos配置
+ + 项目dataId`qihangerp-scm.yaml`（配置内容从docs\qihangerp-scm.yaml复制即可）
+
++ 启动Redis
+
+
++ 启动minio
+
+
+
+### 3.2、启动后端
+
++ 启动`service`下面的所有微服务
++ 启动`api-scm`项目
++ 启动`api-dcm`项目
+
+### 3.3、启动前端 `vue-scm`、`vue-dcm`
++ `npm install`
++ `npm run dev`
++ 打包`npm run build:prod`
++ 访问web
+ + 访问地址：`http://localhost`
+ + 登录名：`admin`
+ + 登录密码：`admin123`
+
+
+
+
+
+## 四、期待您的支持
+
+**感谢大家的关注与支持！希望利用本人从事电商10余年的经验帮助到大家提升工作效率！**
+
+💖 如果觉得有用记得点 Star⭐
+
+
+### 4.1 关注公众号
+
+更多服务，请关注作者微信公众号：qihangerp168
+
+
+
+
+💖 欢迎一起交流！
+
+### 4.2 捐助项目
+作者为兼职做开源,平时还需要工作,如果帮到了您可以请作者吃个盒饭
+
+
+
+
+
+
+
+
diff --git a/README.md b/README.md
index 51ba2073..aaaf151a 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,40 @@
+### 电商系统系列
+
+在兄弟们的鼓励与支持下，经过半年多的时间优化和完善，启航电商系统系列已经形成了三大独立电商业务处理系统，分别覆盖不同场景：
+
++ **1、电商ERP系统**
+
+`电商ERP系统`主要场景是处理电商业务的进销存整体流程。从采购到商品入库、再到订单出库、再到退换货处理等一系列涉及到仓库库存变化的全流程数据跟踪处理。
+
+主要功能包括：采购下单、商品入库（库存批次）、网店订单API拉取、订单商品出库（先入先出法则）、网店售后拉取、售后处理（退货、换货、补发等库存类操作）等。
+
+**订单发货支持添加赠品**
+
+电商ERP系统侧重是对库存数据的全流程跟踪管理，做到库存追踪，数据可直接用于财务核算，所以对库存数据流有严谨的流程和规则。
+
+[启航电商ERP更详细介绍](README-ERP.md)
+
++ **2、电商OMS系统**
+
+`电商OMS系统`主要场景是店铺订单业务处理，包括：订单API拉取、电子面单打印、订单发货、售后API拉取、订单拦截、售后处理等，可以使用接口与ERP系统对接。
+
+系统功能主要包括：店铺商品管理、店铺订单管理、店铺售后管理、电子面单打印等。
+
+**目前支持：淘宝、京东、拼多多、抖店、微信视频号小店**，后续继续支持快手、小红书等。
+
+[启航电商OMS更详细介绍](README-OMS.md)
+
++ **3、电商SCM系统**
+
+`电商SCM系统`主要场景是针对供应链厂家为分销渠道订单一件代发，电商SCM系统有两个后台：供应链厂家发货后台、分销终端订单管理后台。
+
+**主要流程是分销终端推送订单到厂家后台，厂家进行统一打单发货。**
+
+[启航电商SCM更详细介绍](README-SCM.md)
+
## 二、关键流程