Sfoglia il codice sorgente

优化 统一增加各个 service 模块 readme 说明

guoenzhou 14 ore fa
parent
commit
4641a3f4aa

+ 33 - 0
service-agbox/README.md

@@ -0,0 +1,33 @@
+# 巡更管理系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 巡更管理系统 |
+| 分区 | patrol |
+| 英文全称 | Patrol management |
+| 描述 | 提供智能巡更系统 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-agbox |
+
+## 功能说明
+
+- 提供智能巡更系统
+- 支持巡更路线管理
+- 提供巡更记录和状态监控
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-agbox/
+├── service-agbox-api/         # API 接口模块
+├── service-agbox-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 35 - 0
service-ai/README.md

@@ -0,0 +1,35 @@
+# AI 智能体系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | AI 智能体系统 |
+| 分区 | ai |
+| 英文全称 | AI |
+| 描述 | 提供 AI 文本推理,视频算法管理 |
+| 模块分类 | 通用模块 |
+| 工程模块 | service-ai |
+
+## 功能说明
+
+- 提供 AI 文本推理能力
+- 管理视频算法
+- 支持 AI 模型的集成和调用
+- 提供智能分析和处理服务
+
+## 技术栈
+
+- Java
+- Spring Boot
+- AI 模型集成
+- MyBatis
+
+## 模块结构
+
+```
+service-ai/
+├── service-ai-api/         # API 接口模块
+├── service-ai-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 35 - 0
service-alarm/README.md

@@ -0,0 +1,35 @@
+# 告警中心
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 告警中心 |
+| 分区 | alarm |
+| 英文全称 | Alarm |
+| 描述 | 提供告警服务 |
+| 模块分类 | 通用模块 |
+| 工程模块 | service-alarm |
+
+## 功能说明
+
+- 提供告警信息的采集、处理和分发
+- 支持多种告警级别和类型的管理
+- 提供告警通知和处理流程
+- 支持告警历史查询和统计分析
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+- 消息队列(可选)
+
+## 模块结构
+
+```
+service-alarm/
+├── service-alarm-api/         # API 接口模块
+├── service-alarm-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 33 - 0
service-backend/README.md

@@ -0,0 +1,33 @@
+# 后端服务
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 后端服务 |
+| 分区 | backend |
+| 英文全称 | Backend Service |
+| 描述 | 提供基础后端服务支持 |
+| 模块分类 | 通用模块 |
+| 工程模块 | service-backend |
+
+## 功能说明
+
+- 提供基础后端服务功能
+- 支持其他模块的后端需求
+- 提供通用的后端接口和服务
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-backend/
+├── service-backend-api/         # API 接口模块
+├── service-backend-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 34 - 0
service-cdi/README.md

@@ -0,0 +1,34 @@
+# 人防物联系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 人防物联系统 |
+| 分区 | cdi |
+| 英文全称 | Civil Defense IoT |
+| 描述 | 提供人防物联场景应用,对接国动办平台 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-cdi |
+
+## 功能说明
+
+- 提供人防物联场景应用
+- 对接国动办平台
+- 管理人防物联网设备和数据
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+- IoT 协议支持
+
+## 模块结构
+
+```
+service-cdi/
+├── service-cdi-api/         # API 接口模块
+├── service-cdi-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 31 - 0
service-cockpit/README.md

@@ -0,0 +1,31 @@
+# 驾驶舱管理系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 驾驶舱管理系统 |
+| 分区 | ckpt |
+| 英文全称 | Cockpit |
+| 描述 | 提供驾驶舱配置 |
+| 模块分类 | 通用模块 |
+| 工程模块 | service-cockpit |
+
+## 功能说明
+
+- 提供驾驶舱配置管理
+- 支持数据可视化展示
+- 提供仪表盘定制功能
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-cockpit/
+└── pom.xml                  # 模块依赖配置
+```

+ 33 - 0
service-eg/README.md

@@ -0,0 +1,33 @@
+# 门禁控制系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 门禁控制系统 |
+| 分区 | eg |
+| 英文全称 | entrance guard |
+| 描述 | 提供门禁系统应用 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-eg |
+
+## 功能说明
+
+- 提供门禁系统应用
+- 支持门禁设备管理
+- 提供门禁记录管理
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-eg/
+├── service-eg-api/         # API 接口模块
+├── service-eg-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 34 - 0
service-fire/README.md

@@ -0,0 +1,34 @@
+# 消防业务
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 消防业务 |
+| 分区 | dem |
+| 英文全称 | Detachment business data |
+| 描述 | 提供消防业务数据管理 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-fire |
+
+## 功能说明
+
+- 提供消防业务数据管理
+- 支持消防设备监控和告警
+- 提供消防业务流程管理
+- 支持消防数据统计和分析
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-fire/
+├── service-fire-api/         # API 接口模块
+├── service-fire-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 34 - 0
service-ids/README.md

@@ -0,0 +1,34 @@
+# 停车管理系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 停车管理系统 |
+| 分区 | ids |
+| 英文全称 | Parking Management System |
+| 描述 | 提供停车管理系统 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-ids |
+
+## 功能说明
+
+- 提供停车管理系统
+- 支持停车场设备管理
+- 提供停车收费和计费功能
+- 支持车辆进出管理和监控
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-ids/
+├── service-ids-api/         # API 接口模块
+├── service-ids-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 35 - 0
service-iot/README.md

@@ -0,0 +1,35 @@
+# 物联网中心
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 物联网中心 |
+| 分区 | dmp |
+| 英文全称 | Data Management Platform |
+| 描述 | 提供物联网产品和设备管理 |
+| 模块分类 | 通用模块 |
+| 工程模块 | service-iot |
+
+## 功能说明
+
+- 提供物联网产品和设备管理
+- 支持设备数据采集和监控
+- 提供视频中心功能,管理视频摄像头和视频流接口
+- 支持物联网设备的接入和管理
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+- 物联网协议支持
+
+## 模块结构
+
+```
+service-iot/
+├── service-iot-api/         # API 接口模块
+├── service-iot-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 33 - 0
service-issue/README.md

@@ -0,0 +1,33 @@
+# 问题管理系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 问题管理系统 |
+| 分区 | issue |
+| 英文全称 | Issue Management |
+| 描述 | 提供问题管理和跟踪功能 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-issue |
+
+## 功能说明
+
+- 提供问题的创建、管理和跟踪
+- 支持问题状态流转和分配
+- 提供问题统计和分析功能
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-issue/
+├── service-issue-api/         # API 接口模块
+├── service-issue-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 35 - 0
service-job/README.md

@@ -0,0 +1,35 @@
+# 定时服务
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 定时服务 |
+| 分区 | qrt |
+| 英文全称 | FILE |
+| 描述 | 提供定时任务工具管理 |
+| 模块分类 | 服务模块 |
+| 工程模块 | service-job |
+
+## 功能说明
+
+- 提供定时任务的创建、管理和执行
+- 支持多种任务调度策略
+- 提供任务执行状态监控和日志记录
+- 支持任务失败重试机制
+
+## 技术栈
+
+- Java
+- Spring Boot
+- Quartz 或 Spring Scheduler
+- MyBatis
+
+## 模块结构
+
+```
+service-job/
+├── service-job-api/         # API 接口模块
+├── service-job-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 33 - 0
service-meeting/README.md

@@ -0,0 +1,33 @@
+# 智能会议系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 智能会议系统 |
+| 分区 | meeting |
+| 英文全称 | Meeting |
+| 描述 | 提供会议预约系统应用 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-meeting |
+
+## 功能说明
+
+- 提供会议预约系统应用
+- 支持会议管理和资源预约
+- 提供会议通知和提醒功能
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-meeting/
+├── service-meeting-api/         # API 接口模块
+├── service-meeting-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 33 - 0
service-oa/README.md

@@ -0,0 +1,33 @@
+# 智能办公系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 智能办公系统 |
+| 分区 | oa |
+| 英文全称 | oa |
+| 描述 | 提供会议预约系统,工作审批管理 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-oa |
+
+## 功能说明
+
+- 提供会议预约系统
+- 支持工作审批管理
+- 提供办公流程自动化
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-oa/
+├── service-oa-api/         # API 接口模块
+├── service-oa-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 33 - 0
service-park/README.md

@@ -0,0 +1,33 @@
+# 园区管理系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 园区管理系统 |
+| 分区 | park |
+| 英文全称 | Park Management |
+| 描述 | 提供园区综合管理功能 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-park |
+
+## 功能说明
+
+- 提供园区综合管理功能
+- 支持用户管理和认证
+- 提供园区设备和资源管理
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-park/
+├── service-park-api/         # API 接口模块
+├── service-park-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 33 - 0
service-pm/README.md

@@ -0,0 +1,33 @@
+# 项目管理系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 项目管理系统 |
+| 分区 | pm |
+| 英文全称 | Project Management |
+| 描述 | 提供项目管理模块 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-pm |
+
+## 功能说明
+
+- 提供项目管理模块
+- 支持项目的创建、管理和跟踪
+- 提供项目进度和资源管理
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-pm/
+├── service-pm-api/         # API 接口模块
+├── service-pm-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 34 - 0
service-transfer/README.md

@@ -0,0 +1,34 @@
+# 数据转发服务
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 数据转发服务 |
+| 分区 | tas |
+| 英文全称 | transfer |
+| 描述 | 提供时序数据统一接收入口,鉴权,转发 |
+| 模块分类 | 服务模块 |
+| 工程模块 | service-transfer |
+
+## 功能说明
+
+- 提供时序数据统一接收入口
+- 支持数据鉴权
+- 提供数据转发功能
+- 支持多种数据源和目标系统
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-transfer/
+├── service-transfer-api/         # API 接口模块
+├── service-transfer-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 34 - 0
service-tsdb/README.md

@@ -0,0 +1,34 @@
+# 数据存储服务
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 数据存储服务 |
+| 分区 | tsdb |
+| 英文全称 | tsdb proxy |
+| 描述 | 提供时序数据统一存储,查询 |
+| 模块分类 | 服务模块 |
+| 工程模块 | service-tsdb |
+
+## 功能说明
+
+- 提供时序数据统一存储
+- 支持数据查询功能
+- 提供数据存储和检索服务
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+- TDengine 或其他时序数据库
+
+## 模块结构
+
+```
+service-tsdb/
+├── service-tsdb-api/         # API 接口模块
+├── service-tsdb-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```

+ 33 - 0
service-website/README.md

@@ -0,0 +1,33 @@
+# 网站管理系统
+
+## 模块信息
+
+| 项目 | 内容 |
+|------|------|
+| 所属系统(模块) | 网站管理系统 |
+| 分区 | site |
+| 英文全称 | Web site |
+| 描述 | 提供站点管理 CMS 内容管理 |
+| 模块分类 | 应用模块 |
+| 工程模块 | service-website |
+
+## 功能说明
+
+- 提供站点管理 CMS 内容管理
+- 支持网站内容的创建、编辑和发布
+- 提供网站模板和主题管理
+
+## 技术栈
+
+- Java
+- Spring Boot
+- MyBatis
+
+## 模块结构
+
+```
+service-website/
+├── service-website-api/         # API 接口模块
+├── service-website-biz/         # 业务逻辑模块
+└── pom.xml                  # 模块依赖配置
+```