first commit

docs/README.md

@@ -0,0 +1,25 @@
+# 项目文档
+
+## 文档结构
+
+- `api/` - API接口文档
+- `development/` - 开发相关文档
+- `deployment/` - 部署相关文档
+
+## 文档管理规范
+
+1. 所有文档必须包含:
+   - 目标 | 版本号 | 责任人 | 最后更新日期
+   - 变更记录(含修改人、修改内容)
+   - 关联资源链接(代码库/任务编号)
+
+2. 文档更新必须:
+   - 更新版本号(语义化版本 v<主>.<次>.<补丁>)
+   - 提交变更日志(>50字说明)
+
+## 快速链接
+
+- [API文档](./api/README.md)
+- [开发文档](./development/README.md)
+- [部署文档](./deployment/README.md)
+

docs/api/README.md

@@ -0,0 +1,57 @@
+# API接口文档
+
+## 版本信息
+
+- 版本: v1.0.0
+- 最后更新: 2025-01-XX
+- 维护者: 开发团队
+
+## API基础信息
+
+- 基础URL: `http://localhost:5000/api/v1`
+- 认证方式: Bearer Token（如需要）
+- 数据格式: JSON
+
+## 接口列表
+
+### 健康检查
+
+**GET** `/health`
+
+检查服务健康状态
+
+**响应示例:**
+```json
+{
+  "status": "healthy"
+}
+```
+
+### 首页
+
+**GET** `/`
+
+获取首页信息
+
+**响应示例:**
+```json
+{
+  "message": "Hello, World!",
+  "status": "ok"
+}
+```
+
+## 错误码说明
+
+- `200` - 成功
+- `400` - 请求参数错误
+- `401` - 未授权
+- `404` - 资源不存在
+- `500` - 服务器内部错误
+
+## 变更记录
+
+### v1.0.0 (2025-01-XX)
+- 初始版本
+- 添加健康检查和首页接口
+

docs/deployment/README.md

@@ -0,0 +1,101 @@
+# 部署文档
+
+## 版本信息
+
+- 版本: v1.0.0
+- 最后更新: 2025-01-XX
+- 维护者: 运维团队
+
+## 部署前准备
+
+### 1. 环境要求
+
+- Python 3.8+
+- 数据库（MySQL/PostgreSQL/SQLite）
+- 反向代理（Nginx，可选）
+
+### 2. 安装依赖
+
+```bash
+# 安装生产依赖
+pip install -r requirements/base.txt
+pip install -r requirements/production.txt
+```
+
+### 3. 配置环境变量
+
+```bash
+# 设置生产环境
+export FLASK_ENV=production
+
+# 配置必要的环境变量
+# - SECRET_KEY
+# - DATABASE_URL
+# - CORS_ORIGINS
+```
+
+## 部署方式
+
+### 方式1: 使用Gunicorn
+
+```bash
+# 使用配置文件
+gunicorn -c gunicorn.conf.py "src.your_app:create_app()"
+
+# 或直接指定参数
+gunicorn --bind 0.0.0.0:5000 --workers 4 "src.your_app:create_app()"
+```
+
+### 方式2: 使用uWSGI
+
+```bash
+uwsgi --ini uwsgi.ini
+```
+
+### 方式3: 使用Docker
+
+```bash
+# 构建镜像
+docker build -t your_app .
+
+# 运行容器
+docker run -d -p 5000:5000 --env-file .env your_app
+```
+
+## Nginx配置示例
+
+```nginx
+server {
+    listen 80;
+    server_name your_domain.com;
+
+    location / {
+        proxy_pass http://127.0.0.1:5000;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+}
+```
+
+## 监控和日志
+
+### 日志位置
+
+- 应用日志: `logs/app.log`
+- Gunicorn访问日志: `logs/gunicorn_access.log`
+- Gunicorn错误日志: `logs/gunicorn_error.log`
+
+### 监控建议
+
+- 使用Supervisor管理进程
+- 配置日志轮转
+- 设置健康检查端点
+
+## 变更记录
+
+### v1.0.0 (2025-01-XX)
+- 初始版本
+- 添加部署文档
+

docs/development/README.md

@@ -0,0 +1,131 @@
+# 开发文档
+
+## 版本信息
+
+- 版本: v1.0.0
+- 最后更新: 2025-01-XX
+- 维护者: 开发团队
+
+## 开发环境搭建
+
+### 1. 环境要求
+
+- Python 3.8+
+- pip
+- 虚拟环境工具（venv）
+
+### 2. 安装步骤
+
+```bash
+# 创建虚拟环境
+python -m venv .venv
+
+# 激活虚拟环境
+# Windows
+.venv\Scripts\activate
+# Linux/Mac
+source .venv/bin/activate
+
+# 安装依赖
+pip install -r requirements/base.txt
+pip install -r requirements/development.txt
+```
+
+### 3. 配置环境变量
+
+```bash
+# 复制环境变量模板
+cp env.example .env
+
+# 编辑.env文件
+# 至少需要配置:
+# - SECRET_KEY
+# - DATABASE_URL
+# - FLASK_ENV
+```
+
+### 4. 初始化数据库
+
+```bash
+# 初始化迁移
+flask db init
+
+# 创建初始迁移
+flask db migrate -m "Initial migration"
+
+# 应用迁移
+flask db upgrade
+```
+
+### 5. 运行项目
+
+```bash
+python run_dev.py
+```
+
+## 代码规范
+
+### 代码风格
+
+- 使用Black进行代码格式化
+- 使用isort进行导入排序
+- 遵循PEP 8规范
+
+### 代码检查
+
+```bash
+# 格式化代码
+black src/
+
+# 排序导入
+isort src/
+
+# 检查代码
+flake8 src/
+pylint src/
+```
+
+## 测试
+
+### 运行测试
+
+```bash
+# 安装测试依赖
+pip install -r requirements/test.txt
+
+# 运行所有测试
+pytest
+
+# 运行特定测试
+pytest tests/test_example.py
+
+# 生成覆盖率报告
+pytest --cov=src tests/
+```
+
+## 数据库迁移
+
+### 创建迁移
+
+```bash
+flask db migrate -m "描述信息"
+```
+
+### 应用迁移
+
+```bash
+flask db upgrade
+```
+
+### 回滚迁移
+
+```bash
+flask db downgrade
+```
+
+## 变更记录
+
+### v1.0.0 (2025-01-XX)
+- 初始版本
+- 添加开发环境搭建文档
+