From 50685a46df677d90b2f9f7cb8b2b7ac3bd2882aa Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Mon, 3 Nov 2025 08:24:20 +0000 Subject: [PATCH] Update README.md --- README.md | 147 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 121 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 679f4ba..6d94dc2 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,134 @@ # 软件开发实训 -#### 介绍 -{**以下是 Gitee 平台说明，您可以替换此简介** -Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} +## 项目介绍 +这是一个基于 UniApp 开发的综合性实训项目，包含多个后端服务和前端页面，主要用于实现一个签到管理系统。项目集成了多种签到方式（如密码签到、二维码签到、GPS 定位签到、人脸识别签到），并提供管理、查询、统计等辅助功能。 -#### 软件架构 -软件架构说明 +## 项目结构 +- **uniapp/back-end/UserInfo**: 用户信息管理模块，包括用户注册、登录、信息修改等基础功能。 +- **uniapp/back-end/clock_in**: 签到核心模块，支持多种签到方式（密码、二维码、GPS、人脸识别）。 +- **uniapp/back-end/face_recognition**: 人脸识别签到模块，用于实现人脸识别签到功能。 +- **uniapp/back-end/qrcode**: 二维码生成模块，用于生成签到所需的二维码。 +- **uniapp/back-end/query**: 数据查询模块，支持签到记录、用户信息、班级信息等的查询。 +- **uniapp/back-end/reason**: 请假申请与审批模块，支持用户提交请假申请和管理员审批。 +- **uniapp/front-end**: 前端页面模块，使用 UniApp 开发，适配小程序、H5、App 等多端。 +- **web/**: 后端 Web 服务模块，提供 Excel 数据导入导出、AI 图表分析、MCP 智能助手等功能。 +## 主要功能模块 -#### 安装教程 +### 用户管理模块 (UserInfo) +- 用户注册 +- 用户登录 +- 用户信息管理 +- 用户权限管理（普通用户、管理员） -1. xxxx -2. xxxx -3. xxxx +### 签到模块 (clock_in) +- 支持多种签到方式： + - 密码签到 + - 二维码签到 + - GPS 定位签到 + - 人脸识别签到 +- 签到记录存储与查询 +- 签到模板配置 -#### 使用说明 +### 人脸识别签到模块 (face_recognition) +- 人脸比对签到 +- 人脸特征提取与存储 +- 集成第三方人脸识别 SDK -1. xxxx -2. xxxx -3. xxxx +### 二维码生成模块 (qrcode) +- 动态生成签到二维码 +- 支持微信小程序扫码签到 -#### 参与贡献 +### 数据查询模块 (query) +- 查询签到记录 +- 查询班级成员 +- 查询用户签到统计 +- 查询未签到名单 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +### 请假管理模块 (reason) +- 用户提交请假申请 +- 管理员审批请假 +- 请假记录查看 +### 前端模块 (front-end) +- 多平台适配（小程序、H5、App） +- 主页、签到、记录、设置等页面 +- 支持多种签到方式 +- 用户信息管理界面 -#### 特技 +### Web 服务模块 (web/) +- Excel 数据导入导出 +- AI 图表分析 +- 智能助手（MCP） +- 语音识别与处理 -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +## 安装与部署 + +### 后端服务部署 +1. **Java 环境准备**：确保已安装 JDK 17 或更高版本。 +2. **Maven 环境准备**：确保已安装 Maven。 +3. **构建项目**： + ```bash + cd uniapp/back-end + mvn clean package + ``` +4. **运行服务**： + - 用户信息模块： + ```bash + java -jar UserInfo/target/UserInfo-0.0.1-SNAPSHOT.jar + ``` + - 签到模块： + ```bash + java -jar clock_in/target/clock_in-0.0.1-SNAPSHOT.jar + ``` + - 人脸识别模块： + ```bash + java -jar face_recognition/target/face_recognition-0.0.1-SNAPSHOT.jar + ``` + - 数据查询模块： + ```bash + java -jar query/query/target/demo0328-0.0.1-SNAPSHOT.jar + ``` + - 请假模块： + ```bash + java -jar reason/target/reason-0.0.1-SNAPSHOT.jar + ``` + +### 前端部署 +1. **安装 HBuilderX 或 HBuilder** 开发工具。 +2. 打开 `uniapp/front-end` 目录。 +3. 编译并运行项目，选择目标平台（如微信小程序、H5 等）。 + +### Web 服务部署 +1. **Python 环境准备**：确保已安装 Python 3.10 或更高版本。 +2. **安装依赖**： + ```bash + pip install -r web/server/requirements.txt + ``` +3. **启动服务**： + ```bash + cd web/server + python mcp/mcp.py + python mcp/generateChecking.py + python chart_ai/analysis.py + ``` + +## 使用说明 +- **用户注册与登录**：用户可以通过注册页面注册账号，并通过登录页面登录系统。 +- **签到操作**：用户可在签到页面选择不同的签到方式（密码、二维码、GPS、人脸识别）进行签到。 +- **查询签到记录**：用户可在记录页面查看自己的签到记录。 +- **请假申请**：用户可在设置页面提交请假申请，管理员可在管理页面审批。 +- **数据分析**：管理员可通过 Web 端查看签到数据的图表分析和统计信息。 + +## 参与贡献 +1. Fork 本仓库。 +2. 创建新分支 `feat/your-feature-name`。 +3. 提交代码。 +4. 创建 Pull Request。 + +## 特色功能 +- 多平台适配：支持小程序、H5、App。 +- 多种签到方式：密码、二维码、GPS、人脸识别。 +- 数据可视化：支持签到数据的图表分析。 +- 智能助手：集成 AI 智能助手，辅助管理与分析。 +- 请假审批流程：支持完整的请假申请与审批流程。 \ No newline at end of file -- Gitee