# fastapi-web-demo

**Repository Path**: zyanna/fastapi-web-demo

## Basic Information

- **Project Name**: fastapi-web-demo
- **Description**: fastapi, postgresql, celery异步任务框架, redis
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-29
- **Last Updated**: 2025-09-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FastAPI Web Demo

这是一个基于 FastAPI、Redis、PostgreSQL、Celery 和 SQLAlchemy 构建的 Python Web 开发框架，适用于快速搭建高性能的后端服务。

## 快速开始

### 后端开发

请参考 `api/README.md` 获取详细的后端开发指南，包括服务启动、依赖安装、环境配置、数据库迁移和异步任务管理等内容。

---

### 数据库迁移（Alembic）

- **生成迁移脚本**：根据模型变更自动生成数据库迁移脚本。
- **升级数据库**：将数据库升级到最新版本。
- **回滚版本**：回退到上一个数据库版本。
- **查看当前版本**：确认当前数据库的版本状态。

---

### 异步任务（Celery）

- **启动 Worker**：处理异步任务队列。
- **启动 Beat**：运行定时任务调度器。
- **合并启动**：同时运行 Worker 和 Beat。

---

### 主要功能模块

- **用户管理**：支持用户注册、登录、权限控制和用户列表查看。
- **角色权限**：基于角色的访问控制（RBAC）。
- **请求日志**：记录每次请求的详细信息。
- **Token 认证**：使用 JWT 实现安全的用户认证。
- **Redis 集成**：用于缓存和会话管理。
- **日志配置**：统一的日志管理模块。

---

### 核心依赖

- **FastAPI**：高性能的异步 API 框架。
- **SQLAlchemy**：强大的 ORM 工具，支持异步数据库操作。
- **PostgreSQL**：关系型数据库支持。
- **Redis**：用于缓存和会话存储。
- **Celery**：异步任务队列，支持定时任务。

---

### 开发规范

- 使用 `pyproject.toml` 管理项目依赖和构建配置。
- 使用 `.env.example` 配置环境变量。
- 使用 `uv.lock` 锁定依赖版本。

---

### 贡献指南

欢迎提交 Pull Request 和 Issue。请遵循项目的代码风格和提交规范。

---

### 许可证

本项目采用 MIT 许可证。详见 `LICENSE` 文件。