diff --git a/README.md b/README.md new file mode 100644 index 0000000..50d56a5 --- /dev/null +++ b/README.md @@ -0,0 +1,92 @@ +# Hertz 权限管理系统 + +Hertz 权限管理系统是一个基于 Spring Boot 3 和 Vue 3 的前后端分离架构的轻量级权限管理平台。系统集成了用户管理、角色管理、菜单管理等核心功能,采用 RBAC(Role-Based Access Control)模型实现细粒度的权限控制。 + +## 🛠 技术栈 + +### 后端 (Backend) + +- **核心框架**: Spring Boot 3.4.1 +- **持久层**: MyBatis-Plus 3.5.8 +- **安全认证**: Spring Security + JJWT 0.12.6 (Stateless JWT) +- **数据库**: MySQL 8.0+ +- **构建工具**: Maven +- **运行环境**: JDK 21 + +### 前端 (Frontend) + +- **核心框架**: Vue 3.5.24 +- **构建工具**: Vite 7.2.4 +- **UI 组件库**: Element Plus 2.13.1 +- **状态管理**: Pinia 3.0.4 +- **路由管理**: Vue Router 4.6.4 +- **HTTP 客户端**: Axios 1.13.2 + +## ✨ 主要功能 + +- **用户管理**: 用户增删改查、角色分配、状态控制。 +- **角色管理**: 角色创建与权限分配(菜单/按钮级)。 +- **菜单管理**: 动态路由配置,支持目录、菜单、按钮三种类型。 +- **个人中心**: 用户资料更新、密码修改。 + +## 🚀 快速开始 + +### 环境要求 + +- JDK 21+ +- Node.js 18+ +- MySQL 8.0+ + +### 后端启动 + +1. 进入后端目录: + ```bash + cd hertz_springboot + ``` +2. 数据库配置: + - 创建数据库 `hertz_springboot`。 + - 导入初始化脚本 `src/main/resources/schema.sql`。 + - 修改 `src/main/resources/application.yml` 中的数据库连接配置。 +3. 启动服务: + ```bash + mvn spring-boot:run + ``` + 服务默认运行在 `http://localhost:8080`。 + +### 前端启动 + +1. 进入前端目录: + ```bash + cd hertz_springboot_ui + ``` +2. 安装依赖: + ```bash + npm install + ``` +3. 启动开发服务: + ```bash + npm run dev + ``` + 服务默认运行在 `http://localhost:5173`。 + +## 👤 初始账号 + +| 角色 | 用户名 | 密码 | 权限 | +| :--- | :--- | :--- | :--- | +| **管理员** | `hertz` | `123456` | 拥有所有系统权限 | +| **普通用户** | `demo` | `123456` | 仅拥有基本查看权限 | + +## 📂 项目结构 + +```text +hertz_admin_spring/ +├── hertz_springboot/ # 后端工程 (Spring Boot) +├── hertz_springboot_ui/ # 前端工程 (Vue 3 + Vite) +├── 项目说明文档.md # 详细项目文档 +├── 数据库说明文档.md # 数据库设计文档 +└── README.md # 项目概览 (本文档) +``` + +## 📄 许可证 + +本项目采用 MIT 许可证。