diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 8f527a2fd5e73d7cae4027811f114151dde512c8..32e3c122d28672fe10e957e0805dc75dfe0f4573 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -48,7 +48,9 @@ module.exports = { sidebar: { '/guide/': [ '', /* /guide/ */ + 'prepare', /* /guide/prepare.html */ 'install', /* /guide/install.html */ + 'development', /* /guide/development.html */ 'deploying', /* /guide/deploying.html */ 'function', /* /guide/function.html */ ], diff --git a/docs/.vuepress/public/img/guide/deploying/database1.png b/docs/.vuepress/public/img/guide/deploying/database1.png new file mode 100644 index 0000000000000000000000000000000000000000..d2015fe2d4c80160986a1f60cc3431730fe41c20 Binary files /dev/null and b/docs/.vuepress/public/img/guide/deploying/database1.png differ diff --git a/docs/.vuepress/public/img/guide/deploying/database2.png b/docs/.vuepress/public/img/guide/deploying/database2.png new file mode 100644 index 0000000000000000000000000000000000000000..f2c36c72cb05271a6f1da8a11bad53caa58e1ae7 Binary files /dev/null and b/docs/.vuepress/public/img/guide/deploying/database2.png differ diff --git a/docs/.vuepress/public/img/guide/development/development1.png b/docs/.vuepress/public/img/guide/development/development1.png new file mode 100644 index 0000000000000000000000000000000000000000..ac66d9ca77b61bf40f26b30e4dca2bc15461bc51 Binary files /dev/null and b/docs/.vuepress/public/img/guide/development/development1.png differ diff --git a/docs/config/README.md b/docs/config/README.md index 00a1ebdf3f1ae89d8eb956526879eeae54a586c4..1798f9140218a1bcc1403a6dee86d42e5d2aac34 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -52,21 +52,7 @@ ufop.local-storage-path=D:/export ## 数据库配置 -### H2 -打开后台代码，进入 resource 目录，打开 application-dev.properties配置文件, 配置以下内容： - -```properties -#jdbc连接-h2数据库 -spring.datasource.driverClassName=org.h2.Driver -spring.datasource.url = jdbc:h2:file:C:/ProgramData/QiwenNetDisk/file;MODE=MYSQL;DATABASE_TO_LOWER=TRUE -spring.datasource.username=sa -spring.datasource.password= -spring.h2.console.enabled=true -``` - - -### MySQL -打开后台代码，进入 resource 目录，打开 application-prod.properties配置文件, 配置以下内容： +打开后台代码，进入 resource 目录，打开 application.properties配置文件, 配置以下内容： ```properties #jdbc连接-mysql数据库 diff --git a/docs/guide/deploying.md b/docs/guide/deploying.md index b05a6389ea0f524735ddc1d610186421851a6f89..00f418f23d3256bd02e38b12e6f8603a44043824 100644 --- a/docs/guide/deploying.md +++ b/docs/guide/deploying.md @@ -1,27 +1,6 @@ -# 部署 +# 生产部署 - - -## 环境要求 - -源码的编译和运行需要依赖以下开发环境，下面所列的版本号仅供参考 -|开发环境|版本|说明| -|-|-|-| -|JDK|8+|后台 Java 运行环境| -|MySQL|5+|数据库环境| -|Node.js|v12.13.1|前台使用 Node.js 环境开发及运行| -|Nginx|1.17.3|服务器环境运行前台| -|Git|2.24.0|下载代码使用| - -## 数据库配置 - -奇文网盘在Windows环境下，默认启动数据库为自带的嵌入式数据库H2，在Linux环境下，默认使用的是MySQL数据库。 - -H2默认是不需要配置的，如果使用MySQL需要配置数据库连接信息。当然使用哪种数据库也可以由你自己来决定，切换方法请参见：[奇文网盘开发和生产环境切换](https://www.qiwenshare.com/essay/detail/1132) - -使用 MySQL 时，只需要在本地创建数据库 file，表会在后台项目启动时，自动生成 - -## 后台部署 +## 后台 在上一节，已经使用后台代码编译出来了 release 包，该发布包是独立的，可以将它拷贝到任何具有 Java 环境的地方进行执行，release/bin 目录下有多个脚本文件，作用如下： @@ -44,8 +23,6 @@ Started FileApplication in 13.429 seconds (JVM running for 14.517) #### Linux 环境启动及停止 -在 Linux 环境下，默认使用的是生产环境配置，因此需要自建 MySQL 并进行配置，具体配置方法可查看[奇文网盘开发和生产环境切换](https://www.qiwenshare.com/topic/detail/6/1132) - ```bash # 进入到 `bin` 目录下 cd ./release/bin @@ -63,7 +40,7 @@ chmod 777 *.sh ./restart.sh ``` -## 前端部署 +## 前端 #### 打包 diff --git a/docs/guide/development.md b/docs/guide/development.md new file mode 100644 index 0000000000000000000000000000000000000000..7bbaf8e46e1c967b96d29461a18477866a0d4e6d --- /dev/null +++ b/docs/guide/development.md @@ -0,0 +1,27 @@ +# 开发环境运行 + +## 后台 + +将 `qiwen-file` 项目加载到 Intellj IDEA 中, 打开 FileApplication.java 类，运行其中的main 方法： + +运行成功 + +## 前台 +修改根目录下`vue.config.js`中`devServer.proxy.target`的端口修改为后台项目的端口（例如前述的 8081 端口），然后启动： + +```bash +# 本地开发 启动项目 +npm run serve +``` + +::: tip + +每次修改完`vue.config.js`中的配置项，都需要重新启动项目才会生效 + +::: + +启动完成后会自动打开浏览器访问 [http://localhost:8081](http://localhost:8081/)， 你看到下面的页面就代表操作成功了。 + +启动成功 + +接下来你可以修改代码进行业务开发了，本项目内建了状态管理、全局路由等等各种实用的功能来辅助开发，你可以继续阅读和探索左侧的其它文档。 \ No newline at end of file diff --git a/docs/guide/install.md b/docs/guide/install.md index fa84428953b43efc1ceadce63e0382ca14c24e23..21977bd6d03cff3e6dbbcd8007ef7b83cb48adff 100644 --- a/docs/guide/install.md +++ b/docs/guide/install.md @@ -1,18 +1,14 @@ # 下载编译 -此项目为前后端分离项目 -## 后台项目 - -### 代码下载 +## 后台 ```shell git clone https://gitee.com/qiwen-cloud/qiwen-file.git ``` -### 代码编译 本项目是本质上是一个maven工程，因此，在命令行执行普通的maven编译命令即可编译。编译命令如下： -```bash +```shell mvn install ``` @@ -21,24 +17,20 @@ mvn install ::: tip 注意事项 -1. 编译完毕之后，检查根目录下是否生成 release 包，如果生成则说明编译成功 -2. 该 release 包是独立的，你可以将它拷贝到任何具有 Java 环境的地方进行执行。 +1. 编译完毕之后，检查根目录下是否生成 release 目录，如果生成则说明编译成功 +2. 该 release 包是独立的，在生产环境可以直接使用 release 包来运行。 ::: -## 前端项目 +## 前端 -### 代码下载 ```shell git clone https://gitee.com/qiwen-cloud/qiwen-file-web.git ``` -### 代码编译 - -```bash - +```shell # 进入项目目录 cd qiwen-file-web @@ -51,29 +43,9 @@ npm run build ::: tip 注意事项 -编译完毕之后，即可构建出 dist 目录，该dist目录里面的内容即是前台代码构建出来的包，在生产环境可以在nginx服务器里去运行访问 - -::: - - - -#### 开发环境运行 - -修改根目录下`vue.config.js`中`devServer.proxy.target`的端口修改为后台项目的端口（例如前述的 8081 端口），然后启动： - -```bash -# 本地开发 启动项目 -npm run serve -``` - -::: tip - -每次修改完`vue.config.js`中的配置项，都需要重新启动项目才会生效 +1. 编译完毕之后，检查根目录下是否生成 dist 目录，如果生成则说明编译成功 +2. 该dist目录里面的内容即是前台代码构建出来的包，在生产环境可以在nginx服务器里去运行访问 ::: -启动完成后会自动打开浏览器访问 [http://localhost:8081](http://localhost:8081/)， 你看到下面的页面就代表操作成功了。 - -启动成功 -接下来你可以修改代码进行业务开发了，本项目内建了状态管理、全局路由等等各种实用的功能来辅助开发，你可以继续阅读和探索左侧的其它文档。 diff --git a/docs/guide/prepare.md b/docs/guide/prepare.md new file mode 100644 index 0000000000000000000000000000000000000000..f1d167a7f0d354ee041c80d18b32e6dc71ed4539 --- /dev/null +++ b/docs/guide/prepare.md @@ -0,0 +1,34 @@ +# 环境准备 + +## 清单 + +源码的编译和运行需要依赖以下开发环境，下面所列的版本号仅供参考 +|开发环境|版本|说明| +|-|-|-| +|JDK|8.0+|后台 Java 运行环境| +|MySQL|8.0+|环境使用的数据库为MySQL，且数据库版本不低于 8.0| +|Node.js|v12.13.1|前台使用 Node.js 环境开发及运行| +|Maven|Latest version|后台代码编译管理| + + +## 数据库配置 + +### 创建数据库 + +以 HeidiSQL 数据库管理工具为例： + +创建数据库1 + +创建数据库，填写数据库名称，并设置字符校对规则为：`utf8mb4_general_ci` +创建数据库2 + +::: tip 关于数据库脚本 + +**DDL脚本**：为了便于管理，本项目的建表使用JPA模型映射技术，因此数据库配置完成后，启动项目即可，系统会自动完成整个建表过程。 + +**DML脚本**：项目初始化数据脚本存放在静态目录下：`/resource/import.sql`，项目启动后需要执行该初始化脚本，如果没有执行，则会报错，参见：常见问题 > 2 + +::: +### 数据库配置 + +参见：配置 > 数据库配置 \ No newline at end of file