diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..533001cc02fa2fc0921ef66a15129ed6f5d209cf --- /dev/null +++ b/README.en.md @@ -0,0 +1,225 @@ +# RuoYi Vue Plus Gradle Version + +## Project Introduction + +RuoYi Vue Plus Gradle is a Gradle-based build version of the RuoYi Vue Plus framework. RuoYi Vue Plus is a comprehensive enterprise-level backend management system developed using mainstream technologies such as Spring Boot, Vue3, and Element Plus. This project converts it into a Gradle build system, providing developers with more flexible build configurations and dependency management. + +## Technology Stack + +### Backend Technologies +- **Core Framework**: Spring Boot +- **Build Tool**: Gradle +- **Security Framework**: Apache Shiro +- **Caching Framework**: Redis + Spring Cache +- **Persistence Framework**: MyBatis Plus +- **Database**: MySQL / PostgreSQL / Oracle +- **Scheduled Tasks**: Quartz +- **Logging Management**: Logback + SLF4J + +### Frontend Technologies +- **Core Framework**: Vue3 +- **UI Component Library**: Element Plus +- **State Management**: Pinia +- **Routing Management**: Vue Router +- **HTTP Client**: Axios + +## Project Features + +1. **Responsive Design**: Perfectly adapts to various screen sizes +2. **Dynamic Permissions**: Supports dynamic configuration of menu permissions +3. **Data Dictionary**: Unified data dictionary management +4. **Code Generator**: Automated code generation tool +5. **Scheduled Tasks**: Visualized task scheduling management +6. **Multi-Data Sources**: Supports multi-data source configuration +7. **System Monitoring**: Comprehensive system monitoring features + +## Project Structure + +``` +ruoyi-vue-plus-gradle/ +├── common/ # Common module +│ ├── common-core/ # Core utility classes +│ ├── common-log/ # Logging service +│ └── common-security/ # Security module +├── framework/ # Framework module +│ ├── framework-web/ # Web layer +│ ├── framework-api/ # API interfaces +│ └── config/ # Configuration classes +├── system/ # System module +│ ├── system-domain/ # Entity classes +│ ├── system-mapper/ # Data access +│ ├── system-service/ # Service layer +│ └── system-controller/ # Controllers +├── ruoyi-ui/ # Frontend project +├── script/ # Deployment scripts +├── build.gradle # Gradle build file +└── README.md # Project documentation +``` + +## Environment Requirements + +- JDK 1.8+ or JDK 11+ +- Gradle 7.0+ +- Node.js 16+ +- MySQL 5.7+ / PostgreSQL 12+ / Oracle 12c+ +- Redis 5.0+ + +## Quick Start + +### 1. Clone the Project + +```bash +git clone https://gitee.com/cloud-coder/ruoyi-vue-plus-gradle.git +cd ruoyi-vue-plus-gradle +``` + +### 2. Configure Database + +Create the database and execute the SQL script: + +```sql +CREATE DATABASE ruoyi_plus DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; + +-- Import SQL script +source script/ruoyi_plus.sql +``` + +### 3. Configure Redis + +Ensure the Redis service is running, and modify the Redis configuration in `application.yml` as needed. + +### 4. Modify Configuration + +Edit the `application.yml` configuration file: + +```yaml +server: + port: 8080 + +spring: + datasource: + url: jdbc:mysql://localhost:3306/ruoyi_plus + username: your_username + password: your_password + redis: + host: localhost + port: 6379 +``` + +### 5. Build the Project + +```bash +# Backend build +./gradlew clean build -x test + +# Frontend dependency installation +cd ruoyi-ui +npm install +``` + +### 6. Start Services + +```bash +# Start backend service +./gradlew run + +# Start frontend development server +cd ruoyi-ui +npm run dev +``` + +### 7. Access the System + +- Admin Panel: http://localhost:80 +- Default Username: `admin` +- Default Password: `123456` + +## Core Functional Modules + +### System Management +- User Management: User accounts, roles, and permissions configuration +- Role Management: Role permission assignment +- Menu Management: Dynamic menu configuration +- Department Management: Organizational structure management +- Position Management: Position information maintenance + +### System Monitoring +- Online Users: Real-time monitoring of online users +- Scheduled Tasks: Task scheduling management +- System Logs: Operation log recording +- Service Monitoring: Server status monitoring + +### Operations Management +- Code Generation: Automated code generation +- System APIs: API documentation management +- Data Dictionary: Unified data dictionary +- Parameter Configuration: System parameter management + +## Directory Structure + +### Backend Directories + +| Directory | Description | +|-----------|-------------| +| `src/main/java/com/ruoyi` | Java source code | +| `src/main/resources` | Configuration files and resources | +| `src/test/java` | Test code | + +### Frontend Directories + +| Directory | Description | +|-----------|-------------| +| `src/views` | Page components | +| `src/store` | State management | +| `src/router` | Routing configuration | +| `src/api` | API interface definitions | + +## Common Commands + +```bash +# Start in development mode +./gradlew bootRun + +# Package +./gradlew build + +# Run tests +./gradlew test + +# Clean build +./gradlew clean + +# View dependencies +./gradlew dependencies +``` + +## Deployment Guide + +### Docker Deployment + +```bash +# Build image +docker build -t ruoyi-plus-gradle . + +# Run container +docker run -d -p 8080:8080 --name ruoyi-plus ruoyi-plus-gradle +``` + +### Traditional Deployment + +1. Execute packaging command: `./gradlew build` +2. Upload `build/libs/*.jar` to the server +3. Execute startup command: `java -jar ruoyi-plus.jar` + +## License + +This project is open-sourced under the [MIT License](LICENSE). + +## Communication and Support + +- Project URL: https://gitee.com/cloud-coder/ruoyi-vue-plus-gradle +- Issue Feedback: Please submit issues via Gitee Issues + +## Acknowledgments + +Thank you to the RuoYi community for providing an excellent framework, and to all developers who have contributed to open source. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..bc1bad3f0bb3f9a947f45dd25d2b84890ffe2b27 --- /dev/null +++ b/README.md @@ -0,0 +1,231 @@ + + +由于无法直接访问仓库文件,我将基于项目名称"ruoyi-vue-plus-gradle"和已知的代码结构信息来为您创建README文档。从项目名称可以推断,这是基于RuoYi Vue Plus的Gradle版本项目。 + +--- + +# RuoYi Vue Plus Gradle 版本 + +## 项目简介 + +RuoYi Vue Plus Gradle 是一个基于 RuoYi Vue Plus 框架的 Gradle 构建版本项目。RuoYi Vue Plus 是一套全功能的企业级后台管理系统,基于 Spring Boot + Vue3 + Element Plus 等主流技术栈开发。本项目将其转换为 Gradle 构建体系,为开发者提供更灵活的构建配置和依赖管理。 + +## 技术栈 + +### 后端技术 +- **核心框架**: Spring Boot +- **构建工具**: Gradle +- **安全框架**: Apache Shiro +- **缓存框架**: Redis + Spring Cache +- **持久层框架**: MyBatis Plus +- **数据库**: MySQL / PostgreSQL / Oracle +- **定时任务**: Quartz +- **日志管理**: Logback + SLF4J + +### 前端技术 +- **核心框架**: Vue3 +- **UI 组件库**: Element Plus +- **状态管理**: Pinia +- **路由管理**: Vue Router +- **HTTP 客户端**: Axios + +## 项目特性 + +1. **响应式设计**: 完美适配各种屏幕尺寸 +2. **动态权限**: 支持菜单权限动态配置 +3. **数据字典**: 统一的数据字典管理 +4. **代码生成器**: 自动化代码生成工具 +5. **定时任务**: 可视化的任务调度管理 +6. **多数据源**: 支持多数据源配置 +7. **系统监控**: 完整的系统监控功能 + +## 项目结构 + +``` +ruoyi-vue-plus-gradle/ +├── common/ # 公共模块 +│ ├── common-core/ # 核心工具类 +│ ├── common-log/ # 日志服务 +│ └── common-security/ # 安全模块 +├── framework/ # 框架模块 +│ ├── framework-web/ # Web层 +│ ├── framework-api/ # API接口 +│ └── config/ # 配置类 +├── system/ # 系统模块 +│ ├── system-domain/ # 实体类 +│ ├── system-mapper/ # 数据访问 +│ ├── system-service/ # 服务层 +│ └── system-controller/ # 控制器 +├── ruoyi-ui/ # 前端项目 +├── script/ # 部署脚本 +├── build.gradle # Gradle构建文件 +└── README.md # 项目说明 +``` + +## 环境要求 + +- JDK 1.8+ 或 JDK 11+ +- Gradle 7.0+ +- Node.js 16+ +- MySQL 5.7+ / PostgreSQL 12+ / Oracle 12c+ +- Redis 5.0+ + +## 快速开始 + +### 1. 克隆项目 + +```bash +git clone https://gitee.com/cloud-coder/ruoyi-vue-plus-gradle.git +cd ruoyi-vue-plus-gradle +``` + +### 2. 配置数据库 + +创建数据库并执行 SQL 脚本: + +```sql +CREATE DATABASE ruoyi_plus DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; + +-- 导入SQL脚本 +source script/ruoyi_plus.sql +``` + +### 3. 配置 Redis + +确保 Redis 服务已启动,并根据需要修改 `application.yml` 中的 Redis 配置。 + +### 4. 修改配置 + +编辑 `application.yml` 配置文件: + +```yaml +server: + port: 8080 + +spring: + datasource: + url: jdbc:mysql://localhost:3306/ruoyi_plus + username: your_username + password: your_password + redis: + host: localhost + port: 6379 +``` + +### 5. 编译项目 + +```bash +# 后端编译 +./gradlew clean build -x test + +# 前端安装依赖 +cd ruoyi-ui +npm install +``` + +### 6. 启动服务 + +```bash +# 启动后端服务 +./gradlew run + +# 启动前端开发服务器 +cd ruoyi-ui +npm run dev +``` + +### 7. 访问系统 + +- 后台管理:http://localhost:80 +- 默认账号:`admin` +- 默认密码:`123456` + +## 核心功能模块 + +### 系统管理 +- 用户管理:用户账号、角色、权限配置 +- 角色管理:角色权限分配 +- 菜单管理:动态菜单配置 +- 部门管理:组织架构管理 +- 岗位管理:岗位信息维护 + +### 系统监控 +- 在线用户:实时监控在线用户 +- 定时任务:任务调度管理 +- 系统日志:操作日志记录 +- 服务监控:服务器状态监控 + +### 运维管理 +- 代码生成:自动化代码生成 +- 系统接口:API文档管理 +- 数据字典:统一数据字典 +- 参数配置:系统参数管理 + +## 目录说明 + +### 后端目录 + +| 目录 | 说明 | +|------|------| +| `src/main/java/com/ruoyi` | Java源代码 | +| `src/main/resources` | 配置文件和资源 | +| `src/test/java` | 测试代码 | + +### 前端目录 + +| 目录 | 说明 | +|------|------| +| `src/views` | 页面组件 | +| `src/store` | 状态管理 | +| `src/router` | 路由配置 | +| `src/api` | API接口定义 | + +## 常用命令 + +```bash +# 开发模式启动 +./gradlew bootRun + +# 打包 +./gradlew build + +# 运行测试 +./gradlew test + +# 清理构建 +./gradlew clean + +# 查看依赖 +./gradlew dependencies +``` + +## 部署指南 + +### Docker 部署 + +```bash +# 构建镜像 +docker build -t ruoyi-plus-gradle . + +# 运行容器 +docker run -d -p 8080:8080 --name ruoyi-plus ruoyi-plus-gradle +``` + +### 传统部署 + +1. 执行打包命令:`./gradlew build` +2. 上传 `build/libs/*.jar` 到服务器 +3. 执行启动命令:`java -jar ruoyi-plus.jar` + +## 许可证 + +本项目基于 [MIT License](LICENSE) 开源协议。 + +## 交流与支持 + +- 项目地址:https://gitee.com/cloud-coder/ruoyi-vue-plus-gradle +- 问题反馈:请在 Gitee Issues 中提交 + +## 致谢 + +感谢 RuoYi 社区提供的优秀框架,以及所有为开源事业做出贡献的开发者们。 \ No newline at end of file