# quickSpringboot

**Repository Path**: creepzzart/quick-springboot

## Basic Information

- **Project Name**: quickSpringboot
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-14
- **Last Updated**: 2026-01-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# QuickSpringBoot 项目

一个基于 Spring Boot 3 + Vue 3 的现代化全栈开发模板，提供前后端分离的快速开发基础框架。

## 📁 项目结构

```
quickSpringboot/
├── quickfront/          # Vue 3 前端项目
└── quickspringboot/    # Spring Boot 3 后端项目
```

## 🚀 技术栈

### 后端 (quickspringboot)
- **Spring Boot 3** - 后端主框架
- **Spring Web MVC** - RESTful API 支持
- **Spring Data JPA** - 数据持久层
- **Spring Validation** - 参数校验
- **MySQL Connector** - MySQL 数据库驱动
- **Lombok** - 代码简化工具
- **Spring Boot DevTools** - 开发热部署

### 前端 (quickfront)
- **Vue 3** - 前端框架
- **Vite 5** - 构建工具和开发服务器
- **Vue Router 4** - 路由管理
- **Pinia 3** - 状态管理
- **Element Plus 2.7** - UI组件库
- **Element Plus Icons** - 图标库
- **MockJS** - 开发环境模拟数据

## 🛠️ 快速开始

### 后端启动

1. **环境准备**
   - JDK 17+
   - Maven 3.6+
   - MySQL 8.0+

2. **数据库配置**
   ```sql
   CREATE DATABASE quickdb CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
   ```

3. **配置文件**
   修改 `application.yml` 中的数据库连接信息：
   ```yaml
   spring:
     datasource:
       url: jdbc:mysql://localhost:3306/quickdb
       username: your_username
       password: your_password
   ```

4. **启动项目**
   ```bash
   cd quickspringboot
   mvn spring-boot:run
   ```
   服务将在 http://localhost:8080 启动

### 前端启动

1. **环境准备**
   - Node.js 18+
   - npm 或 yarn

2. **安装依赖**
   ```bash
   cd quickfront
   npm install
   ```

3. **启动开发服务器**
   ```bash
   npm run dev
   ```
   应用将在 http://localhost:5173 启动

4. **构建生产版本**
   ```bash
   npm run build
   ```

## 📦 项目特性

### 后端特性
- ✅ RESTful API 设计
- ✅ 全局异常处理
- ✅ 参数自动校验
- ✅ JPA 自动建表
- ✅ 开发热重启
- ✅ 集成测试支持

### 前端特性
- ✅ Vue 3 Composition API
- ✅ 响应式状态管理
- ✅ 路由权限控制
- ✅ Element Plus 组件
- ✅ 开发环境 Mock 数据
- ✅ 现代化构建工具

## 📚 API 设计规范

### 响应格式
```json
{
  "code": 200,
  "message": "操作成功",
  "data": {},
  "timestamp": "2024-01-15T10:30:00"
}
```

### 状态码说明
- `200`: 成功
- `400`: 请求参数错误
- `401`: 未授权
- `403`: 禁止访问
- `404`: 资源不存在
- `500`: 服务器内部错误

## 🧪 测试

### 后端测试
```bash
cd quickspringboot
mvn test
```

### 前端测试
开发模式下自动支持 HMR（热模块替换）

## 🔧 开发配置

### IDE 推荐
- **后端**: IntelliJ IDEA 或 VS Code with Spring Boot Extension Pack
- **前端**: VS Code with Volar Extension

### 推荐插件
- **后端**: Lombok, Spring Boot Tools
- **前端**: Vue Language Features (Volar), ESLint, Prettier

## 📁 目录结构说明

### 后端目录结构
```
quickspringboot/
├── src/main/java/
│   ├── com/quick/
│   │   ├── config/     # 配置类
│   │   ├── controller/ # 控制器
│   │   ├── entity/     # 实体类
│   │   ├── repository/ # 数据访问层
│   │   ├── service/    # 业务逻辑层
│   │   ├── dto/        # 数据传输对象
│   │   └── exception/  # 异常处理
├── src/main/resources/
│   ├── application.yml # 配置文件
│   └── static/         # 静态资源
```

### 前端目录结构
```
quickfront/
├── src/
│   ├── api/           # API 接口
│   ├── assets/        # 静态资源
│   ├── components/    # 组件
│   ├── router/        # 路由配置
│   ├── stores/        # Pinia 状态管理
│   ├── views/         # 页面组件
│   └── utils/         # 工具函数
```

## 🚢 部署

### 后端部署
```bash
cd quickspringboot
mvn clean package -DskipTests
java -jar target/quickspringboot-1.0.0.jar
```

### 前端部署
构建后，将 `dist` 目录内容部署到 Nginx 或任何静态文件服务器。

## 📄 许可证

MIT

## 🤝 贡献

欢迎提交 Issue 和 Pull Request！

## 📞 支持

如有问题，请提交 Issue 或联系项目维护者。

---

**Happy Coding!** 🎉