1
0
mirror of https://github.com/fumiama/paper-manager.git synced 2026-06-09 10:21:00 +08:00

edit README

This commit is contained in:
源文雨
2023-03-19 00:34:13 +08:00
parent caa805b7a4
commit a68b139320

View File

@@ -1,6 +1,16 @@
# paper-manager
面向教师的试卷网络管理系统基于Golang+vben。项目由前端后端两大部分组成没有中间件。
## main.go
统合前后端为单一可执行文件静态访问交给前端API部分则转交后端处理。
### 参数
- **-l**: 设置监听地址与端口
### 监听处理点位
- **/api/\*\*\***: 所有信令 API
- **/file/\*\*\***: 所有上传的文件(动态文件)
- **/upload**: 上传文件接口,上传的文件会统一存至`./data/file/`以供访问
## 前端
> 位于`frontend`文件夹
@@ -9,11 +19,10 @@
### 登录页 /login
#### 登录
> 登录时将依次访问`/api/getLoginSalt` `/api/login` `/api/getUserInfo`
输入账号密码登录。登录成功后,前端将查询并缓存用户名、权限、头像、简介等信息备用,同时导航到指定的家页面。
- **课程组长**:导航到分析页`/dashboard/analysis`
- **其他人**:导航到工作台`/dashboard/workbench`
> 登录时将依次访问`/api/getLoginSalt` `/api/login` `/api/getUserInfo`
#### 忘记密码
点击`忘记密码`后填写用户名与手机号码,再点击`重置`,即可将重置消息报告给课程组长,由课程组长电话联系确认无误后,在系统中批准进行密码重置。
#### 注册
@@ -22,9 +31,8 @@
![login screen](https://user-images.githubusercontent.com/41315874/226117983-c1e69916-def0-4746-939a-5041412b755f.png)
### 注销
> 注销时将访问`/api/logout`
该功能位于右上角状态栏头像的下拉列表中,点击`退出系统`后即可注销登录。
> 注销时将访问`/api/logout`
### 仪表板/分析页 /dashboard/analysis
### 仪表板/工作台 /dashboard/workbench
@@ -33,18 +41,17 @@
个人设置位于右上角状态栏头像的下拉列表中,点击后即可对用户自己的信息进行设置。
#### 基本设置
对用户的昵称、个人简介与头像进行自定义设置。
> 上传头像时,访问`/upload`
> 保存设置时,访问`/api/setUserInfo`
对用户的昵称、个人简介与头像进行自定义设置。
#### 安全设置
> 将访问到`/api/setPassword` `/api/setContact`
对用户的密码、联系方式进行修改。
- **密码**:导航至`/settings/password`进行设置,成功后将自动退出当前登录,同时在系统消息中通知课程组长。
- **联系方式**:导航至`/settings/contact`进行设置,成功后会在系统消息中通知课程组长。
> 设置密码时,访问`/api/setPassword`
> 设置联系方式时,访问`/api/setContact`
### 试卷库 /filelist
@@ -52,11 +59,3 @@
> 位于`backend`文件夹
基于标准`http`不用重框架负责提供各种API。
## main.go
统合前后端为单一可执行文件静态访问交给前端API部分则转交后端处理。
### 参数
- **-l**: 设置监听地址与端口
### 监听处理点位
- **/api/\*\*\***: 所有信令 API
- **/file/\*\*\*xxx**: 所有上传的文件(动态文件)
- **/upload**: 上传文件接口,上传的文件会统一存至`./data/file/`以供访问