Files
railwaysystem/README.md
T

86 lines
4.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# RailwaySystem 智慧培训系统
RailwaySystem 是一套面向铁路职工与业务学员的一站式智慧培训管理系统。系统基于 Spring Boot 2.5、若依(RuoYi-Vue)底座、Vue 2.6 与国产人大金仓(KingbaseES)数据库构建,全面覆盖从学员档案、师资管理、开班排课、报到考勤、宿舍分配、门禁授权到动态考核与综合画像的全流程业务闭环。
---
## 📚 文档中心快速导航
本项目文档实行**业务需求与技术架构分层治理**:
| 文档中心 | 目录入口 | 核心重点内容 | 适用角色 |
| :--- | :--- | :--- | :--- |
| **业务与产品需求中心** | [doc/README.md](doc/README.md) | ★★★ [PRD V1.0 业务需求基线](doc/RailwaySystem%20智慧培训系统一期%20PRD%20V1.0.md)(正式冻结基线,32章全景规范)、原始甲供资料、历史版本演进 | 产品经理、业务方、测试、全栈开发 |
| **技术架构与系统审计中心** | [docs/README.md](docs/README.md) | ★★★ [Phase 0 真实基线与审计总结](docs/codebase-audit/17_phase0_summary.md)、18 篇全景代码与数据库实测快照报告 | 架构师、后端研发、前端研发、DBA |
---
## 🛠 技术栈
- **后端架构**:Java 8+ / Spring Boot 2.5 / Spring Security / MyBatis / PageHelper / RuoYi-Vue
- **前端架构**:Vue 2.6 / Vue Router / Vuex / Element UI / Axios / ECharts
- **数据库底座**:国产人大金仓 **KingbaseES V009R003C018**(MySQL 兼容模式,JDBC 驱动 8.6.0)
- **缓存与会话**:Redis 6+
---
## 🚀 快速启动指南
### 1. 运行前置条件
1. **Java**:JDK 8、11 或 17+
2. **Node.js**:Node 16+(系统已兼容适配 Node 22/OpenSSL 3.x)
3. **Redis**:本地启动 Redis 服务(默认端口 `6379`,无密码)
4. **网络/跳板机**:数据库部署在内网(`192.168.139.218:4321`),通过 Tailscale 跳板机节点 `100.70.157.41`(账号 `wzb`)建立端口转发隧道。
### 2. 一键启动(推荐)
项目根目录下已提供一键启动脚本 [start-local.sh](start-local.sh):
```bash
cd /Users/wzb/Desktop/项目/RailwaySystem
./start-local.sh
```
脚本将自动执行:
- 检查并唤醒本地 Redis;
- 检查并建立针对 Kingbase 数据库的跳板机 SSH 端口转发(`127.0.0.1:4321`);
- 清理历史冲突端口,启动 Spring Boot 后端(端口 `8090`);
- 启动前端开发服务器(端口 `8080`)。
### 3. 系统默认访问入口
- **前端应用界面**:[http://localhost:8080](http://localhost:8080)
- **后端接口服务**:[http://localhost:8090](http://localhost:8090)
- **默认管理员账号**:`admin`
- **默认密码**:`admin123`
---
## 📁 目录结构导览
```text
RailwaySystem/
├── README.md # 【本文件】项目总览、架构导览与启动指南
├── start-local.sh # 本地一键启动脚本(集成数据库隧道与前后端并发启动)
├── RuoYi-Vue/ # 后端工程(Spring Boot 单体增强版)
│ ├── ruoyi-admin/ # Web 启动入口与 Controller 接口层
│ ├── ruoyi-framework/ # 框架核心配置、WebSecurity 与拦截器
│ ├── ruoyi-system/ # 核心业务模块(含培训管理业务 Entity/Mapper/Service)
│ ├── ruoyi-common/ # 公共常量、工具类与通用组件
│ └── ruoyi-ui/ # 若依原始/历史前端资产(不作为当前 Final Browser Acceptance 主构建源)
├── build_ui/ # 当前 Final Candidate 实际构建和部署使用的 Vue 前端工程
│ ├── src/api/ # 前端 Axios 接口层(含 train 培训业务接口)
│ ├── src/views/train/ # 培训业务页面视图(学员、排课、宿舍、考勤等)
│ └── package.json # 前端依赖与 Webpack 构建配置
├── doc/ # 业务与产品需求中心(PRD V1.0、原始资料与归档)
└── docs/ # 技术架构、发布门禁与代码审计中心(包含 V2 架构、API/DB 规范与验收证据)
```
---
## 📌 开发与演进原则
1. **业务基线不可逆**:任何新页面开发、字段扩充与业务校验,统一以 [PRD V1.0](doc/RailwaySystem%20智慧培训系统一期%20PRD%20V1.0.md) 为唯一依据,旧版草案已全部归档。
2. **非破坏性演进**:对 Kingbase 数据库与若依权限系统进行改造时,严格遵循技术审计报告结论,保持历史数据安全与可回滚性。