Files
railwaysystem/README.md
T

64 lines
4.1 KiB
Markdown
Raw Normal View History

# SYFJGYD学员管理系统
> **内部工程代码代号**:`RailwaySystem`
> **共享试用环境**:[http://192.168.139.230:8082/](http://192.168.139.230:8082/)(部署分支:`feat/cicd-pipeline`)
> **质量验证状态**:后端全量测试 **331 / 331 PASS (0 Failures / 0 Errors)**,管理员/教师/学员三角色无头浏览器 E2E 验证全绿通过。
> **试用就绪度判定**:`READY_WITH_EXTERNAL_BLOCKERS`(核心教务全链路打通,具备局域网试用条件)。
---
## 📖 系统简介
**SYFJGYD学员管理系统**是专为沈阳房建公寓段短周期铁路职工集中面授培训量身研发的一体化数字化教务管理平台。
系统基于 Spring Boot 2.5、若依(RuoYi-Vue)企业级底座、Vue 2.6 前端框架以及国产人大金仓(KingbaseES)高安全数据库构建。全面贯穿从基础教务资源维护、开班计划编排、学员批量建档(国密SM4脱敏)、四维时段冲突排课、现场人脸/扫码报到、课次考勤打卡到结训归档的全生命周期。
```mermaid
flowchart LR
A["基础资源就绪"] --> B["开班计划制定"]
B --> C["本期课程绑定"]
C --> D["参训学员名册"]
D --> E["四维冲突排课"]
E --> F["开班现场报到"]
F --> G["课堂考勤打卡"]
G --> H["结训状态流转"]
H --> I["历史档案沉淀"]
```
---
## 🧭 核心文档权威直达 (Documentation Map)
为避免在海量文档中迷失,请根据当前需求直接点击对应权威入口:
| 你的目标 | 推荐直达入口 | 核心内容与说明 |
| :--- | :--- | :--- |
| 🌟 **想快速了解项目现在做到哪了** | [**docs/current/**](docs/current/README.md) | **【首选入口】** 当前系统状态速览、试用数据大盘、需求落地度与行动计划。 |
| 📋 **想对照一期功能需求与待确认项** | [**docs/requirements/**](docs/requirements/一期需求实现进度表.md) | 一期需求逐项代码实现进度表、以及面向甲方的待确认清单 (P0/P1/P2)。 |
| 📚 **想系统了解业务流程与技术架构** | [**docs/handbook/**](docs/handbook/01-project-overview.md) | 面向团队的系统级手册(涵盖项目总览、业务流程、架构设计、数据模型与开发部署)。 |
| 🔌 **想对接后端 API 接口或 DTO 契约** | [**docs/api-v2/**](docs/api-v2/00_readme.md) | 冻结的 REST API 契约、入参出参模型定义与业务错误码规范。 |
| 🗄️ **想查阅国产金仓数据库物理表结构** | [**docs/database-v2/**](docs/database-v2/01_table_inventory.md) | 21 张真实物理业务表字段清单、索引约束与迁移方案说明。 |
| 🖥️ **想给领导/老师/专家进行生动展示** | [**docs/visual/index.html**](docs/visual/index.html) | **纯静态离线交付门户**,包含可交互业务状态机拓扑、系统架构图与 14 大模块导览。 |
| 📑 **想查阅最终验收结果与测试日志** | [**docs/reports/**](docs/reports/README.md) | 包含当前唯一的最终验收报告 (FINAL_PHASE1) 及各轮次自动化测试证据链。 |
---
## 🚀 快速启动指南 (开发环境)
### 1. 基础环境要求
- **JDK**:Java 8、11 或 17+
- **Node.js**:Node 16+(兼容 Node 22 与 OpenSSL 3.x)
- **Redis**:本地启动 Redis 6+ 服务(默认端口 `6379`,无密码)
- **数据库**:国产人大金仓 KingbaseES V9(通过跳板机隧道直连 `127.0.0.1:4321`,库名 `train_v2`)
### 2. 一键启动本地服务
项目根目录下提供了全自动化本地启动脚本:
```bash
./start-local.sh
```
该脚本将自动唤醒本地 Redis、建立 Kingbase SSH 隧道、启动 Spring Boot 后端(端口 `8090`)以及启动前端工程(端口 `8080`)。
### 3. 访问入口
- **前端系统界面**:`http://localhost:8080`(本地开发) / [http://192.168.139.230:8082](http://192.168.139.230:8082)(内部共享试用环境)
- **后端 API 服务**:`http://localhost:8090`(本地开发) / `http://192.168.139.230:8092`(共享试用环境)
- **默认管理员**:`admin`(密码请咨询管理员,文档中不记录敏感凭据)