From a6d38b1454c6c2ace1a64b1e35786af578636855 Mon Sep 17 00:00:00 2001
From: toesbieya <1647775459@qq.com>
Date: Thu, 16 Jul 2020 13:47:34 +0800
Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=9B=B4=E6=96=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/.vuepress/config.js |  8 ++++++++
 docs/backend/README.md   | 13 +++++++++++++
 docs/frontend/README.md  |  2 ++
 docs/installation.md     | 18 +++++++++++-------
 docs/start.md            | 21 +++++++++++++++++++++
 5 files changed, 55 insertions(+), 7 deletions(-)
 create mode 100644 docs/backend/README.md
 create mode 100644 docs/start.md

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
index 9864f8b..fc52c4d 100644
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -21,6 +21,7 @@ module.exports = {
 
         sidebar: [
             'installation',
+            'start',
             {
                 title: '前端',
                 collapsable: false,
@@ -56,6 +57,13 @@ module.exports = {
                     '/frontend/plugins'
                 ]
             },
+            {
+                title:'后端',
+                collapsable: false,
+                children: [
+                    '/backend/',
+                ]
+            }
         ]
     },
 
diff --git a/docs/backend/README.md b/docs/backend/README.md
new file mode 100644
index 0000000..a4ec279
--- /dev/null
+++ b/docs/backend/README.md
@@ -0,0 +1,13 @@
+# 介绍
+
+后端分local和cloud版，对应 `java/local` 和 `java/cloud` 目录，可以根据自行选择。
+
+local版基于SpringBoot、SpringMVC、Mybatis开发。
+
+cloud版基于SpringBoot、SpringCloud、SpringCloudAlibaba、SpringMVC、Mybatis-Plus开发
+，服务间调用使用dubbo，未使用分布式事务。
+
+目前两者在功能上的差别就是local版支持动态修改资源的限流设置，而cloud版由于还在研究sentinel中，
+所以还未实现，暂时以gateway的 `default-filters` 作为替代。
+
+*文档完善中。。。*
diff --git a/docs/frontend/README.md b/docs/frontend/README.md
index 4189b7b..3d37384 100644
--- a/docs/frontend/README.md
+++ b/docs/frontend/README.md
@@ -1,5 +1,7 @@
 # 介绍
 
+这是在[vue-element-admin](https://github.com/PanJiaChen/vue-element-admin) 的基础上改造而来的。
+
 ## 功能
 
 ```
diff --git a/docs/installation.md b/docs/installation.md
index 893cf01..6b982da 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -2,11 +2,12 @@
 
 ## 环境准备
 
-- jdk1.8
-- mysql8
-- redis3.2
+- jdk 1.8
+- mysql 8
+- redis 3.2+
 - node
 - npm
+- nacos 1.3.1-BETA（如果是local版则不需要，[下载地址](https://github.com/alibaba/nacos/releases)）
 
 ::: warning 注意
 后端开发时ide需要安装lombok插件
@@ -14,12 +15,15 @@
 
 ## 基础信息配置
 
-- 导入位于`java`目录下的sql脚本（初始管理员账号密码：admin/123456）
+- 新建一个数据库，导入位于`/java/db`目录下的sql脚本（初始管理员账号密码：admin/123456）
 
-- 修改`java/src/main/resources/application.yml`中的`datasource`、`redis`、`socket`、`file`、`qiniu`等配置项
+- 修改后端配置中的`datasource`、`redis`、`socket`、`qiniu`等配置项，
+  local版的配置文件是`java/local/src/main/resources/application.yml`，
+  cloud版的配置文件是各个模块的`boostrap.yml`以及`java/cloud/nacos-config`下的文件
 
-- 根据注释修改`vue/src/config/index.js`中的变量，通常只需要修改`socketUrl`、`attachmentPrefix`、`filePreviewPrefix`即可
+- 根据注释修改`vue/src/config/index.js`中的变量，
+  通常只需要修改`socketUrl`、`attachmentPrefix`、`filePreviewPrefix`即可
 
 ::: warning 注意
-如果后端部署到服务器上，yml中的socket.hostname需要是服务器的局域网ip，否则socket服务端创建不了
+如果后端部署到服务器上，socket配置中的hostname需要是服务器的局域网ip，否则socket服务端创建不了
 :::
diff --git a/docs/start.md b/docs/start.md
new file mode 100644
index 0000000..eae1ced
--- /dev/null
+++ b/docs/start.md
@@ -0,0 +1,21 @@
+# 启动
+
+### 前端
+
+```shell script
+npm run serve
+```
+
+### 后端
+
+local版直接运行启动类即可
+
+cloud版请按以下步骤启动：
+
+1. 下载并配制好nacos后，按照nacos的文档启动nacos。
+
+2. 将`/nacos-config`下的文件打包成`DEFAULT_GROUP.ZIP`，然后在nacos的web端上导入。
+
+3. 按一定顺序启动各个模块。`websocket`、`schedule`、`gateway` 这三个可以按任意顺序启动，
+   `record` 必须要在**其他的web-modules**前启动，`account` 必须要在 `system` 之后启动，
+   `document` 必须要在 `stock` 之后启动，剩余的可以按任意顺序启动。