docs: 📚 文档修改

This commit is contained in:
Bunny 2024-10-26 03:59:47 +08:00
parent 47ab8de897
commit 819e33482d
30 changed files with 33 additions and 32 deletions

View File

@ -8,13 +8,14 @@ Gitee地址
- [前端地址](https://gitee.com/BunnyBoss/bunny-admin-web)
- [后端地址](https://gitee.com/BunnyBoss/bunny-admin-server)
# 产品特点
# 项目特点
前端项目基于[pure-admin](https://github.com/pure-admin/pure-admin-thin)开源项目进行了改进和优化RBAC基于角色的访问控制。在我项目中后端负责验证请求地址的访问权限。
前端项目基于[pure-admin](https://github.com/pure-admin/pure-admin-thin)
开源项目进行了改进和优化RBAC基于角色的访问控制。在我项目中后端负责验证请求地址的访问权限。
整个项目都采用响应式设计,可以兼容移动设备,除了表格显示在移动端可能不够友好外,其他方面表现良好。由于表格本身具有一定的复杂性,手机上查看效果可能不理想,目前无法对其进行修改。
![image-20241026032407486](./image/ReadMe/image-20241026032407486.png)
![image-20241026032407486](images/image-20241026032407486.png)
## 1. 首页定制
@ -30,11 +31,11 @@ Gitee地址
系统菜单图标支持动态图标。
![image-20241026025901761](./image/ReadMe/image-20241026025901761.png)
![image-20241026025901761](images/image-20241026025901761.png)
在添加外链时,路由名称即为外链地址。
![image-20241026025825052](./image/ReadMe/image-20241026025825052.png)
![image-20241026025825052](images/image-20241026025825052.png)
### 用户管理
@ -42,29 +43,29 @@ Gitee地址
其中系统中有一个默认用户是不会在前台用户进行展示的`Administrator`这个用户是系统预留,以防出错或维护使用
![image-20241026030000099](./image/ReadMe/image-20241026030000099.png)
![image-20241026030000099](images/image-20241026030000099.png)
### 角色权限管理
权限管理中的权限添加支持树型结构。
![image-20241026030034998](./image/ReadMe/image-20241026030034998.png)
![image-20241026030034998](images/image-20241026030034998.png)
![image-20241026030057212](./image/ReadMe/image-20241026030057212.png)
![image-20241026030057212](images/image-20241026030057212.png)
在新增权限时请求地址可以是正则表达式或者Java中的antpath两者皆可兼容。
![image-20241026030247782](./image/ReadMe/image-20241026030247782.png)
![image-20241026030247782](images/image-20241026030247782.png)
部门管理同样采用树型结构。
![image-20241026030105402](./image/ReadMe/image-20241026030105402.png)
![image-20241026030105402](images/image-20241026030105402.png)
## 3. 系统配置
### 菜单图标
![image-20241026030355125](./image/ReadMe/image-20241026030355125.png)
![image-20241026030355125](images/image-20241026030355125.png)
### 邮件用户配置
@ -74,19 +75,19 @@ Gitee地址
其中默认选项无论有多少用户最终默认的只会有一个
![image-20241026030534421](./image/ReadMe/image-20241026030534421.png)
![image-20241026030534421](images/image-20241026030534421.png)
### 邮件模板
第一个是发送验证码邮件模板
![image-20241026030557224](./image/ReadMe/image-20241026030557224.png)
![image-20241026030557224](images/image-20241026030557224.png)
### 前端页面配置
因为这个模板作者将配置选项放在了前端文件中的`public`文件夹下, 配置选项现已变为动态,交给后端管理
![image-20241026030621707](./image/ReadMe/image-20241026030621707.png)
![image-20241026030621707](images/image-20241026030621707.png)
## 4. 系统监控
@ -94,43 +95,43 @@ Gitee地址
查看当前服务的CPU占用情况使用SpringBoot中的`actuator`端点。图表每2秒请求一次页面兼容移动设备。
![image-20241026031050902](./image/ReadMe/image-20241026031050902.png)
![image-20241026031050902](images/image-20241026031050902.png)
### 后台文件管理
![image-20241026031117116](./image/ReadMe/image-20241026031117116.png)
![image-20241026031117116](images/image-20241026031117116.png)
### 用户登录日志
![image-20241026031206836](./image/ReadMe/image-20241026031206836.png)
![image-20241026031206836](images/image-20241026031206836.png)
### 任务执行日志
使用任务调度时执行状态都会记录在这个里面
![image-20241026031240109](./image/ReadMe/image-20241026031240109.png)
![image-20241026031240109](images/image-20241026031240109.png)
### 系统缓存
项目中使用了SpringCache如果请求的内容可以缓存在SpringCache中
![image-20241026031252429](./image/ReadMe/image-20241026031252429.png)
![image-20241026031252429](images/image-20241026031252429.png)
## 5. 定时任务
![image-20241026031339987](./image/ReadMe/image-20241026031339987.png)
![image-20241026031339987](images/image-20241026031339987.png)
![image-20241026031346612](./image/ReadMe/image-20241026031346612.png)
![image-20241026031346612](images/image-20241026031346612.png)
## 6. 多语言
![image-20241026031403524](./image/ReadMe/image-20241026031403524.png)
![image-20241026031403524](images/image-20241026031403524.png)
![image-20241026031411689](./image/ReadMe/image-20241026031411689.png)
![image-20241026031411689](images/image-20241026031411689.png)
## 外部页面
![image-20241026031448707](./image/ReadMe/image-20241026031448707.png)
![image-20241026031448707](images/image-20241026031448707.png)
# 环境部署
@ -181,7 +182,7 @@ proxy_set_header X-Forwarded-Proto $scheme;
NGINX的文件
```
```nginx
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
@ -221,25 +222,25 @@ server {
若无法下载请先使用pnpm下载。若不需使用pnpm请删除或修改相应内容。
![image-20241026025057129](./image/ReadMe/image-20241026025057129.png)
![image-20241026025057129](images/image-20241026025057129.png)
### docker配置
![image-20241026024116090](./image/ReadMe/image-20241026024116090.png)
![image-20241026024116090](images/image-20241026024116090.png)
### 配置环境
设置启动端口号和项目地址机器后端请求地址
![image-20241026024813858](./image/ReadMe/image-20241026024813858.png)
![image-20241026024813858](images/image-20241026024813858.png)
#### 配置线上环境
设置项目启动端口号,线上环境默认请求路径为`/admin`需在NGINX中将访问请求前缀更改为`/admin`。
![image-20241026024940747](./image/ReadMe/image-20241026024940747.png)
![image-20241026024940747](images/image-20241026024940747.png)
![image-20241026024243785](./image/ReadMe/image-20241026024243785.png)
![image-20241026024243785](images/image-20241026024243785.png)
#### 配置开发环境
@ -247,11 +248,11 @@ server {
前端设置的请求前缀为`/api`,但后端接受的前缀为`/admin`,因此需在服务中修改此内容。
![image-20241026024318644](./image/ReadMe/image-20241026024318644.png)
![image-20241026024318644](images/image-20241026024318644.png)
**修改请求路径**
![image-20241026031651591](./image/ReadMe/image-20241026031651591.png)
![image-20241026031651591](images/image-20241026031651591.png)
### 部署命令

View File

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

View File

Before

Width:  |  Height:  |  Size: 180 KiB

After

Width:  |  Height:  |  Size: 180 KiB

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

Before

Width:  |  Height:  |  Size: 183 KiB

After

Width:  |  Height:  |  Size: 183 KiB

View File

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

View File

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

View File

Before

Width:  |  Height:  |  Size: 101 KiB

After

Width:  |  Height:  |  Size: 101 KiB

View File

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 96 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 89 KiB

View File

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 62 KiB

View File

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View File

Before

Width:  |  Height:  |  Size: 81 KiB

After

Width:  |  Height:  |  Size: 81 KiB

View File

Before

Width:  |  Height:  |  Size: 105 KiB

After

Width:  |  Height:  |  Size: 105 KiB

View File

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 70 KiB

View File

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 59 KiB

View File

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

View File

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

View File

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

View File

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 57 KiB

View File

Before

Width:  |  Height:  |  Size: 120 KiB

After

Width:  |  Height:  |  Size: 120 KiB

View File

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

View File

Before

Width:  |  Height:  |  Size: 117 KiB

After

Width:  |  Height:  |  Size: 117 KiB

View File

Before

Width:  |  Height:  |  Size: 134 KiB

After

Width:  |  Height:  |  Size: 134 KiB

View File

Before

Width:  |  Height:  |  Size: 110 KiB

After

Width:  |  Height:  |  Size: 110 KiB