# todomaster-backend

**Repository Path**: freecpu/todomaster-backend

## Basic Information

- **Project Name**: todomaster-backend
- **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-03-20
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TodoMaster Backend

待办事项管理系统 - 后端服务

## 技术栈

- **框架**: Spring Boot 3.2.0
- **JDK**: OpenJDK 17
- **数据库**: PostgreSQL 15
- **缓存**: Redis 6
- **认证**: JWT
- **文档**: Swagger/OpenAPI 3.0

## 快速开始

### 环境要求

- JDK 17+
- Maven 3.8+
- PostgreSQL 15
- Redis 6

### 本地开发

1. 配置环境变量：
```bash
export DB_HOST=localhost
export DB_PORT=5432
export DB_NAME=todomaster
export DB_USER=todomaster
export DB_PASSWORD=your_password
export REDIS_HOST=localhost
export JWT_SECRET=your_secret_key
```

2. 构建项目：
```bash
mvn clean package -DskipTests
```

3. 运行应用：
```bash
mvn spring-boot:run
```

4. 访问 Swagger 文档：
```
http://localhost:8080/swagger-ui.html
```

### Docker 部署

```bash
# 构建镜像
docker build -t todomaster-backend:latest .

# 运行容器
docker run -d \
  -p 8901:8080 \
  -e DB_HOST=postgres \
  -e REDIS_HOST=redis \
  -e JWT_SECRET=your_secret \
  todomaster-backend:latest
```

## 项目结构

```
src/
├── main/
│   ├── java/com/todomaster/backend/
│   │   ├── config/          # 配置类
│   │   ├── controller/      # 控制器
│   │   ├── service/         # 服务层
│   │   ├── repository/      # 数据访问层
│   │   ├── entity/          # 实体类
│   │   ├── dto/             # 数据传输对象
│   │   └── util/            # 工具类
│   └── resources/
│       ├── db/              # 数据库脚本
│       └── application.yml  # 应用配置
└── test/
    └── java/                # 测试代码
```

## API 文档

完整 API 文档请查看：
- Swagger UI: `/swagger-ui.html`
- OpenAPI JSON: `/v3/api-docs`
- 项目文档：`../docs/api.md`

## 数据库初始化

执行 `src/main/resources/db/schema.sql` 创建表结构。

## 开发规范

- 提交格式：`[后端] 模块 - 描述`
- 示例：`[后端] 用户 - 登录接口实现`

## 端口说明

| 环境 | 端口 |
|------|------|
| 本地开发 | 8080 |
| Docker 部署 | 8901 |

## 作者

柱子 <zhuzi@openclaw.local>

## 许可证

MIT