📝 完善用户手册

This commit is contained in:
ronger 2023-04-25 15:46:04 +08:00
parent 70d9f38998
commit 6dfb793345

View File

@ -1,10 +1,9 @@
# forest 食用手册 # forest 食用手册
感谢使用 forest以下是本项目的开发手册你将了解到如何从零开始进行开发环境的搭建。运行本项目需要用到Mysql和Redis你可以使用自己配置好的 感谢使用 forest以下是本项目的开发手册你将了解到如何从零开始进行开发环境的搭建。运行本项目需要用到 MySQL 和 Redis你可以使用自己配置好的
Mysql 和 Redis也可以使用本项目提供的`docker`的方式快速搭建 Mysql 和 Redis 环境。 MySQL 和 Redis也可以使用本项目提供的 `docker` 的方式快速搭建 MySQL 和 Redis 环境。
本项目提供了两种方式,你可以一步一步按照教程来配置,也可以 本项目提供了两种方式,你可以一步一步按照教程来配置,也可以直接使用 `docker` 快速运行本项目。
直接使用`docker`快速运行本项目。
## 获取最新代码到本地 ## 获取最新代码到本地
@ -13,42 +12,37 @@ git clone "https://github.com/rymcu/forest"
``` ```
## 开发环境搭建 ## 开发环境搭建
> 本项目在以下开发环境下开发,其他环境下可能会出现兼容性问题,建议使用以下环境进行开发。
你可以使用自己配置好的 Mysql 和 Redis也可以使用本项目提供的`docker`的方式快速搭建 Mysql 和 Redis 环境。
### 方式1
你需要自己配置好下面的环境,下面是本项目所使用的基础开发环境,在运行项目前,请确保你已经配置好基础开发环境。
- IDE: `JetBrains IntelliJ IDEA UItimate` - IDE: `JetBrains IntelliJ IDEA UItimate`
- `Java 8` - `Java 8(8u101 +)`
- `Mysql v8.0.29` - `MySQL v7.x +`
- `Redis v7.0.8` - `Redis v7.x +`
### 方式2 ### 手动搭建 MySQL 和 Redis 环境
> 手动安装 MySQL 时,需初始化数据库。
该方式使用 Docker 搭建 Mysql 和 Redis 的开发环境 在配置好 MySQL 和 Redis 的环境之后,在运行项目前,你还需要初始化好数据库中数据。通过执行 `src/main/resources/static`
目录下的 `forest.sql` 文件进行数据库初始化操作。
![forest-sql](https://static.rymcu.com/article/1650261394563.png)
### 使用 docker 快速搭建 MySQL 和 Redis 环境
> 使用 docker 快速搭建 MySQL 和 Redis 环境时,请修改 `docker\dev` 目录下的 `docker-compose.yml` 文件中的默认密码。
- 确保你已经安装了 `Docker`和`Docker-compose` - 确保你已经安装了 `Docker`和`Docker-compose`
- 在 `docker\dev` 目录下执行 `docker-compose up` 可初始化 `redis``mysql` 环境 - 在 `docker\dev` 目录下执行 `docker-compose up` 可初始化 `redis``mysql` 环境
- 如需修改相关配置,请编辑 `docker\dev` 目录下的 `docker-compose.yml` 文件 - 如需修改相关配置,请编辑 `docker\dev` 目录下的 `docker-compose.yml` 文件
### 初始化数据库
在配置好 Mysql 和 Redis 的环境之后,在运行项目前,你还需要初始化好数据库中数据。通过执行 `src/main/resources/static`
目录下的 `forest.sql` 文件进行数据库初始化操作。
![forest-sql](https://static.rymcu.com/article/1650261394563.png)
### 配置文件说明 ### 配置文件说明
在初始化好数据库之后,你需要在`application.yml`中进行基本信息的配置,具体分为如下几个部分。 在初始化好数据库之后,你需要在`application.yml`中进行相关信息的配置,具体分为如下几个部分。
#### 数据库配置 #### 数据库配置
```yaml ```yaml
datasource: datasource:
url: jdbc:mysql://localhost:3306/forest?characterEncoding=UTF-8&autoReconnect=true&useSSL=false&serverTimezone=Asia/Shanghai&allowMultiQueries=true url: jdbc:mysql://localhost:3306/forest?characterEncoding=UTF-8&autoReconnect=true&useSSL=false&serverTimezone=Asia/Shanghai
username: root username: root
password: # 数据库密码 password: # 数据库密码
driver-class-name: com.mysql.cj.jdbc.Driver driver-class-name: com.mysql.cj.jdbc.Driver
@ -56,7 +50,6 @@ datasource:
- `characterEncoding` 指定处理字符的解码和编码的格式 - `characterEncoding` 指定处理字符的解码和编码的格式
- `serverTimezone` 指定时区 - `serverTimezone` 指定时区
- `allowMultiQueries` 允许多行 `sql` 一起执行
#### redis 配置 #### redis 配置
@ -96,19 +89,6 @@ resource:
pic-path: /yoursrc/xx/nebula/static # 上传文件存储地址,本地测试时填写前端项目路径下的 static 目录即可 pic-path: /yoursrc/xx/nebula/static # 上传文件存储地址,本地测试时填写前端项目路径下的 static 目录即可
``` ```
#### 百度相关配置(可选择)
```yaml
baidu:
data:
site: https://yourdomain.com # 百度搜索(SEO)绑定网站域名
token: xxxx
ai:
appId: xxx # 百度AI-文字识别 应用 appId
appKey: xxxx # 百度AI-文字识别 应用 appKey
secretKey: xxxx # 百度AI-文字识别 应用 secretKey
```
### 运行项目 ### 运行项目
在你完成了前面的操作之后,就可以直接运行`ForestApplication.java`启动项目了,至此,如果后端项目已经成功启动,则可以切换到 在你完成了前面的操作之后,就可以直接运行`ForestApplication.java`启动项目了,至此,如果后端项目已经成功启动,则可以切换到