# Miracle

**Repository Path**: hpxl/Miracle

## Basic Information

- **Project Name**: Miracle
- **Description**: 骑行攻略社区小程序-大学毕业设计，基于springboot+vue+uniapp构建
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-08-26
- **Last Updated**: 2025-08-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Miracle 项目文档

## 项目概述

Miracle 是一个包含后台管理系统、客户端应用和后端服务的完整项目，适用于构建多功能管理系统。项目分为三个主要部分：

- **Miracle-Admin**：后台管理系统的前端部分，基于 Vue 框架构建。
- **Miracle-Client**：客户端应用，基于 UniApp 构建，适用于多端部署。
- **Miracle-Server**：后端服务，基于 Spring Boot 框架，提供 RESTful API 接口。

## 项目结构

### Miracle-Admin
- 基于 Vue 的后台管理系统，包含用户管理、角色管理、权限控制、数据字典、通知公告等功能。
- 使用 Vue Router、Vuex、Element Plus 等主流 Vue 技术栈。
- 支持主题切换、布局设置、国际化等功能。

### Miracle-Client
- 客户端应用，适用于 H5、小程序、App 等多端部署。
- 使用 UniApp 框架，支持 Vue 3 语法。
- 包含首页、详情页、通知、评论、用户中心等模块。

### Miracle-Server
- 后端服务，基于 Spring Boot + MyBatis Plus 构建。
- 提供 RESTful API 接口，支持用户认证、权限控制、数据管理等功能。
- 使用 Sa-Token 进行权限管理，集成 Swagger 生成 API 文档。
- 包含用户管理、角色管理、资源管理、评论、通知、帖子、骑行路线等模块。

## 技术栈

### Miracle-Admin
- Vue 3
- Vite
- Element Plus
- Vue Router
- Vuex
- TypeScript
- Axios
- Sass
- UnoCSS

### Miracle-Client
- UniApp
- Vue 3
- TypeScript
- Sass
- Pinia
- Axios
- UniApp 自定义组件

### Miracle-Server
- Spring Boot
- MyBatis Plus
- Sa-Token（权限控制）
- Swagger UI（API 文档）
- MySQL
- Redis
- Maven

## 快速开始

### 环境要求

- Node.js（Miracle-Admin 和 Miracle-Client）
- JDK 17+（Miracle-Server）
- MySQL 8.0+
- Redis

### 安装步骤

#### Miracle-Server
1. 克隆项目：
   ```bash
   git clone https://gitee.com/zs2084035767/Miracle.git
   ```
2. 导入数据库：
   ```bash
   mysql -u root -p < Miracle-Server/miracle.sql
   ```
3. 修改配置文件：
   ```bash
   vi Miracle-Server/src/main/resources/application.yml
   ```
4. 启动项目：
   ```bash
   cd Miracle-Server
   mvn spring-boot:run
   ```

#### Miracle-Admin
1. 安装依赖：
   ```bash
   cd Miracle-Admin
   pnpm install
   ```
2. 启动开发服务器：
   ```bash
   pnpm dev
   ```

#### Miracle-Client
1. 安装依赖：
   ```bash
   cd Miracle-Client
   pnpm install
   ```
2. 启动开发服务器：
   ```bash
   pnpm dev:h5
   ```

## 功能模块

### 用户管理
- 用户注册、登录、注销
- 用户信息管理
- 用户角色分配
- 密码修改、重置

### 角色管理
- 角色创建、编辑、删除
- 角色权限分配
- 角色启用/禁用

### 权限管理
- 菜单权限、按钮权限控制
- 基于 Sa-Token 的权限验证
- 支持动态路由加载

### 数据字典
- 字典类型管理
- 字典数据管理
- 支持启用/禁用字典项

### 通知公告
- 发布通知公告
- 通知公告分页展示
- 通知公告编辑、删除

### 评论管理
- 用户评论管理
- 评论分页展示
- 评论删除、编辑

### 帖子管理
- 用户发布帖子
- 帖子分页展示
- 帖子详情查看
- 帖子评论功能

### 骑行路线
- 骑行路线管理
- 路线详情展示
- 路线评论功能

## API 文档

后端 API 文档可通过 Swagger 访问，默认地址为：

```
http://localhost:8080/swagger-ui.html
```

## 贡献指南

欢迎贡献代码和改进文档。请遵循以下步骤：

1. Fork 项目
2. 创建新分支
3. 提交代码
4. 创建 Pull Request

## 许可证

本项目采用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。