From 7692bfbfa55e97e3be50267eda710fa8c5d05065 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 9 Jan 2026 14:51:07 +0000 Subject: [PATCH] Add README.md --- README.en.md | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 99 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 196 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..889a093 --- /dev/null +++ b/README.en.md @@ -0,0 +1,97 @@ +# Wisdom Municipal Management Platform + +## Project Overview + +`wisdom-master` is an enterprise-level backend management system built on the Spring Boot framework. Primarily designed for the municipal engineering domain, this project provides comprehensive functionalities including work order processing, maintenance management, quantity calculation, approval workflows, and system operations. The system integrates enterprise-grade components such as RBAC permission control, Redis caching, and a code generator, making it suitable for various business scenarios like municipal road maintenance and water resource management. + +## Technology Stack + +* **Core Framework**: Spring Boot +* **Persistence Layer**: MyBatis-Plus +* **Security Framework**: Spring Security + JWT (JSON Web Token) +* **Caching**: Redis +* **Database**: MySQL +* **Task Scheduling**: Quartz +* **API Documentation**: Swagger +* **Logging**: Logback + +## Project Structure + +The project adopts a Maven multi-module structure, primarily consisting of the following modules: + +* **wisdom-admin**: The entry module for the management backend, containing system configuration, web controllers (Controller), the main application class, and static resource handling. +* **wisdom-common**: The common component module, providing general utilities (Utils), custom annotations (Annotation), exception handling (Exception), enums (Enums), and core domain entities (Domain). +* **wisdom-framework**: The framework core configuration module, including security configuration, data source aspect (DataSource Aspect), MyBatis configuration, Redis configuration, and global exception handling. +* **wisdom-system**: The business logic implementation module. + * **municipal**: Core municipal functions (work orders, repair menus, engineering vouchers, team management). + * **hr**: Human resources (leave applications). + * **process**: Workflow management (process definition, instance approval). +* **wisdom-generator**: The code generator module, supporting automatic generation of Controller, Service, and Mapper code based on database table structures. +* **wisdom-quartz**: The scheduled task management module, used for managing system cron jobs. + +## Core Functional Modules + +### 1. Municipal Work Order Management +* **Work Order Handling**: Supports creation, querying, modification, and deletion (soft delete) of work orders. +* **Batch Operations**: Enables batch submission, batch approval, and batch return. +* **Data Synchronization**: Provides APIs to receive synchronized work order data from external systems. +* **Status Management**: End-to-end status tracking (e.g., pending submission, pending review, completed). +* **Quantity Reporting**: Supports detailed work quantity records per work order (earthwork, labor, machinery shifts, etc.). + +### 2. Repair Menu & Engineering Voucher +* **Repair Menu Generation**: Bulk generation of repair menus from aggregated work orders. +* **Multi-Level Approval**: + * **Area Manager Review**: Initial review of repair content and work quantities. + * **Department Head Review**: Secondary confirmation. +* **Engineering Voucher**: Generates and exports engineering vouchers with detailed quantity calculations and cost breakdowns. +* **Signature Support**: Integrates handwritten and artistic signature functions for electronic seals during approval workflows. + +### 3. Workflow Engine +* **Process Definition**: Supports customization of workflow nodes and approval roles. +* **Process Approval**: Provides functionalities to initiate, approve (approve/reject), and withdraw workflows. +* **Visualization**: Retrieves process node graphs (Node Graph) and approval history. + +### 4. System Management +* **Users & Roles**: RBAC-based user permission management with data-level access filtering. +* **Departments & Teams**: Manages organizational structure and construction team information. +* **Data Dictionary**: Maintains system-wide enum data. +* **Operation Logs**: Comprehensive logging of all operations for audit trails. +* **Monitoring**: Server status monitoring, online user monitoring, and cache monitoring. + +### 5. Integration Services +* **DingTalk Integration**: Supports DingTalk QR code login, user information synchronization, and organizational structure synchronization. +* **File Handling**: Supports image upload, download, and conversion. + +## Quick Start + +### Environment Requirements +* JDK 1.8 or higher +* Maven 3.0+ +* MySQL 5.7+ / 8.0+ +* Redis 3.0+ + +### Configuration Instructions + +1. **Database Initialization**: Import the initialization SQL files from the `sql/` directory. +2. **Modify Configuration**: Edit `wisdom-admin/src/main/resources/application.yml` or the corresponding environment-specific configuration file to set up database and Redis connection details. + ```yaml + spring: + datasource: + # Configure database connection details + redis: + # Configure Redis connection details + ``` +3. **Run the Project**: + Execute the following commands from the project root directory: + ```bash + mvn clean package -DskipTests + cd wisdom-admin/target + java -jar wisdom-admin.jar + ``` + +### Access the System +After successful startup, access the backend management interface (typically at `http://localhost:8080`) and log in using the default administrator account. + +## License + +This project is licensed under an open-source license. For detailed licensing information, please refer to the `LICENSE` file in the project root directory. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..7fe1dbc --- /dev/null +++ b/README.md @@ -0,0 +1,99 @@ + + +# 智慧市政管理系统 (Wisdom Municipal Management Platform) + +## 项目简介 + +`wisdom-master` 是一个基于 Spring Boot 框架构建的企业级后台管理系统。该项目主要面向市政工程领域，提供完整的工单流转、维修管理、工程量核算、审批流程以及系统运维等功能。系统集成了 RBAC 权限控制、Redis 缓存、代码生成器等企业级组件，适用于市政道路维护、水务管理等多个业务场景。 + +## 技术栈 + +* **核心框架**: Spring Boot +* **持久层框架**: MyBatis-Plus +* **安全框架**: Spring Security + JWT (JSON Web Token) +* **缓存**: Redis +* **数据库**: MySQL +* **任务调度**: Quartz +* **API 文档**: Swagger +* **日志**: Logback + +## 项目结构 + +项目采用 Maven 多模块结构，主要包含以下模块： + +* **wisdom-admin**: 管理后台入口模块，包含系统配置、Web 控制器（Controller）、启动类和静态资源处理。 +* **wisdom-common**: 公共组件模块，提供通用工具类（Utils）、自定义注解（Annotation）、异常处理（Exception）、枚举（Enums）和核心领域实体（Domain）。 +* **wisdom-framework**: 框架核心配置模块，包含安全配置、数据源切面（DataSource Aspect）、MyBatis 配置、Redis 配置以及全局异常处理。 +* **wisdom-system**: 业务逻辑实现模块。 + * **municipal**: 市政业务核心（工单、维修菜单、工程签证、班组管理）。 + * **hr**: 人力资源（请假申请）。 + * **process**: 工作流管理（流程定义、实例审批）。 +* **wisdom-generator**: 代码生成器模块，支持根据数据库表结构自动生成 Controller、Service、Mapper 代码。 +* **wisdom-quartz**: 定时任务管理模块，用于管理系统定时任务。 + +## 核心功能模块 + +### 1. 市政工单管理 (Municipal Work Order) +* **工单处理**: 实现工单的创建、查询、修改、删除（软删）。 +* **批量操作**: 支持批量提交、批量审批、批量退回。 +* **数据同步**: 提供接口接收外部系统同步的工单数据。 +* **状态管理**: 全流程状态跟踪（待提交、待审核、已完成等）。 +* **工程量填报**: 支持为每个工单维护详细的工作量数据（土方、人工、机械台班等）。 + +### 2. 维修菜单与工程签证 (Repair Menu & Voucher) +* **维修菜单生成**: 批量将工单汇总生成维修菜单。 +* **多级审核**: + * **片区长审核**: 对维修内容和工作量进行初审。 + * **科长审核**: 二审确认。 +* **工程签证**: 生成并导出工程签证单，包含工程量核算和费用明细。 +* **签名支持**: 集成手写签名和艺术字签名功能，用于审批流程中的电子签章。 + +### 3. 工作流引擎 (Workflow) +* **流程定义**: 支持自定义流程节点和审批角色。 +* **流程审批**: 提供流程启动、审批（通过/退回）、撤回功能。 +* **可视化**: 获取流程节点图（Node Graph）和审批历史。 + +### 4. 系统管理 (System Management) +* **用户与角色**: 基于 RBAC 的用户权限管理，支持数据权限过滤。 +* **部门与班组**: 管理组织架构及施工班组信息。 +* **数据字典**: 维护系统通用枚举数据。 +* **操作日志**: 全面的操作日志记录，便于审计追踪。 +* **监控**: 服务器状态监控、在线用户监控、缓存监控。 + +### 5. 集成服务 (Integration) +* **钉钉集成**: 支持钉钉扫码登录、用户信息同步、组织架构同步。 +* **文件处理**: 支持图片上传、下载及转换。 + +## 快速开始 + +### 环境要求 +* JDK 1.8 或更高版本 +* Maven 3.0+ +* MySQL 5.7+ / 8.0+ +* Redis 3.0+ + +### 配置说明 + +1. **数据库初始化**: 导入 `sql/` 目录下的初始化 SQL 文件。 +2. **修改配置**: 编辑 `wisdom-admin/src/main/resources/application.yml` 或对应环境的配置文件，配置数据库连接和 Redis 连接信息。 + ```yaml + spring: + datasource: + # 配置数据库连接信息 + redis: + # 配置 Redis 连接信息 + ``` +3. **运行项目**: + 在项目根目录执行： + ```bash + mvn clean package -DskipTests + cd wisdom-admin/target + java -jar wisdom-admin.jar + ``` + +### 访问系统 +启动成功后，访问后台管理页面（通常为 `http://localhost:8080`），使用初始管理员账户登录。 + +## License + +本项目遵循开源协议，具体许可信息请参阅项目根目录下的 `LICENSE` 文件。 \ No newline at end of file -- Gitee