# task-flow

**Repository Path**: make-mm/task-flow

## Basic Information

- **Project Name**: task-flow
- **Description**: 代办任务
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-26
- **Last Updated**: 2026-01-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

The provided code map indicates that this is a Java-based task flow management system with features including authentication, task management, notifications, and security configurations. Based on this structure, here's a README tailored for this project:

---

# Task Flow 管理系统

这是一个基于 Java 的任务流程管理平台，提供任务创建、管理、提醒以及用户认证功能。适用于需要任务流程控制和用户权限管理的中后台应用场景。

---

## 📌 功能亮点

- **用户认证**：支持账户密码登录、短信验证码登录、退出登录等功能。
- **任务管理**：支持任务创建、编辑、删除、状态更新及分页展示。
- **通知提醒**：提供未读通知获取与已读标记功能。
- **权限控制**：基于 Spring Security 和 JWT 的认证与访问控制。
- **定时任务**：自动提醒即将到期的任务。

---

## 🧰 技术栈

- **Spring Boot**：快速构建微服务架构。
- **MyBatis Plus**：数据库访问层框架。
- **JWT**：用于用户认证和 Token 管理。
- **Redis**：缓存 Token 和验证码。
- **Knife4j / OpenAPI**：接口文档自动生成。
- **Quartz / Scheduled**：定时任务调度。

---

## 🛠️ 模块结构

- **auth**：认证中心，处理登录、登出、Token 管理。
- **controller**：API 接口层，包含任务和通知接口。
- **model**：数据模型，包含实体类、视图对象、表单对象等。
- **service**：业务逻辑层，包含任务、用户、通知等服务。
- **mapper**：数据库映射层。
- **config**：系统配置类，如 Security、Redis、MyBatis 配置。
- **security**：安全控制模块，包括 JWT 过滤器、权限判断等。
- **exception**：全局异常处理。
- **task**：定时任务模块，处理任务到期提醒。

---

## 📦 环境依赖

- JDK 1.8+
- Maven 3.5+
- MySQL 5.7+
- Redis 3.0+

---

## 🚀 快速启动

1. **克隆项目**

```bash
git clone https://gitee.com/make-mm/task-flow.git
```

2. **导入数据库**

使用 `sql.mysql/task_flow.sql` 初始化数据库。

3. **配置文件修改**

根据需要修改 `application.yml` 或 `application-dev.yml` 中的数据库、Redis、JWT 等配置。

4. **运行项目**

```bash
mvn spring-boot:run
```

访问 [http://localhost:8080](http://localhost:8080) 查看接口文档或使用前端页面进行操作。

---

## 📚 接口文档

访问 `/doc.html` 查看 Knife4j 提供的 OpenAPI 接口文档。

---

## 📝 贡献指南

欢迎贡献代码、提交 issue 和 PR。请遵循以下步骤：

1. Fork 仓库
2. 创建新分支
3. 提交代码并描述变更
4. 提交 PR 并等待审核

---

## 📄 协议

本项目采用 [MIT License](https://opensource.org/licenses/MIT)，详情请查看 LICENSE 文件。

---