# todo_platform

**Repository Path**: iDai/todo_platform

## Basic Information

- **Project Name**: todo_platform
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-17
- **Last Updated**: 2026-04-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 企业待办管理平台

## 项目概述

一个企业级员工日常任务管理平台，支持用户注册登录、任务增删改查、筛选排序、数据统计等功能。

## 技术栈

### 后端
- **运行时**: Node.js 20.x LTS
- **框架**: Express 4.x
- **语言**: TypeScript 5.x
- **数据库**: PostgreSQL 15.x
- **ORM**: Prisma 5.x
- **认证**: JWT (jsonwebtoken)
- **密码加密**: bcrypt
- **校验**: Zod
- **日志**: Winston

### 前端
- **框架**: React 18.x
- **语言**: TypeScript 5.x
- **构建工具**: Vite 5.x
- **UI 库**: Ant Design 5.x
- **状态管理**: Zustand
- **服务端状态**: TanStack Query (React Query)
- **路由**: React Router 6.x
- **日期处理**: dayjs

## 项目结构

```
todo-platform/
├── backend/                 # 后端项目
│   ├── src/
│   │   ├── config/         # 配置 (数据库、日志等)
│   │   ├── controllers/    # 控制器
│   │   ├── middlewares/    # 中间件
│   │   ├── routes/         # 路由
│   │   ├── services/       # 业务逻辑
│   │   ├── types/          # TypeScript 类型
│   │   ├── utils/          # 工具函数
│   │   └── validators/     # 请求校验
│   ├── prisma/
│   │   └── schema.prisma   # 数据库模型
│   └── package.json
│
├── frontend/                # 前端项目
│   ├── src/
│   │   ├── api/            # API 请求
│   │   ├── assets/         # 静态资源
│   │   ├── components/     # 组件
│   │   ├── constants/      # 常量
│   │   ├── hooks/          # 自定义 Hooks
│   │   ├── pages/          # 页面
│   │   ├── stores/         # 状态管理
│   │   ├── types/          # TypeScript 类型
│   │   └── utils/          # 工具函数
│   └── package.json
│
└── README.md
```

## 功能模块

### 认证模块
- 用户注册（邮箱+密码）
- 用户登录
- JWT Token 认证
- 用户信息获取/更新
- 密码修改

### 任务模块
- 创建任务（标题、描述、优先级、截止日期）
- 任务列表（分页、筛选、排序、搜索）
- 任务详情
- 更新任务
- 删除任务（软删除）
- 任务状态流转（待办 → 进行中 → 已完成）

### 统计模块
- 任务概览统计
- 按优先级统计
- 按日期统计

## 快速开始

### 环境要求
- Node.js >= 18.0.0
- PostgreSQL >= 15.0
- npm >= 9.0.0

### 后端启动

```bash
# 1. 进入后端目录
cd backend

# 2. 安装依赖
npm install

# 3. 配置环境变量
cp .env.example .env
# 编辑 .env 文件，配置数据库连接等信息

# 4. 执行数据库迁移
npm run db:migrate

# 5. 启动开发服务器
npm run dev
```

后端服务将在 http://localhost:3000 启动

### 前端启动

```bash
# 1. 进入前端目录
cd frontend

# 2. 安装依赖
npm install

# 3. 启动开发服务器
npm run dev
```

前端服务将在 http://localhost:5173 启动

## API 文档

API 基础路径: `/api/v1`

### 认证接口

| 方法 | 路径 | 描述 | 认证 |
|------|------|------|------|
| POST | /auth/register | 用户注册 | 否 |
| POST | /auth/login | 用户登录 | 否 |
| GET | /auth/me | 获取当前用户 | 是 |
| POST | /auth/logout | 退出登录 | 是 |
| PUT | /auth/user/profile | 更新用户信息 | 是 |
| PUT | /auth/user/password | 修改密码 | 是 |

### 任务接口

| 方法 | 路径 | 描述 | 认证 |
|------|------|------|------|
| GET | /tasks | 获取任务列表 | 是 |
| POST | /tasks | 创建任务 | 是 |
| GET | /tasks/:id | 获取单个任务 | 是 |
| PUT | /tasks/:id | 更新任务 | 是 |
| DELETE | /tasks/:id | 删除任务 | 是 |

### 统计接口

| 方法 | 路径 | 描述 | 认证 |
|------|------|------|------|
| GET | /stats | 获取任务统计 | 是 |

完整的 API 文档请参考 `docs/API.md`

## 部署文档

### Docker 部署

```bash
# 构建镜像
docker build -t todo-platform-backend .
docker build -t todo-platform-frontend .

# 运行容器
docker-compose up -d
```

### 生产环境部署

请参考 `docs/DEPLOYMENT.md`

## 开发文档

- [API 文档](docs/API.md)
- [部署文档](docs/DEPLOYMENT.md)
- [用户手册](docs/USER_MANUAL.md)

## 许可证

MIT License