FastAPI + React 项目技术文档

FastAPI + React 项目技术文档

fastapi-react 🚀 Cookiecutter Template for FastAPI + React Projects. Using PostgreSQL, SQLAlchemy, and Docker 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-react

1. 安装指南

1.1 安装 Cookiecutter

首先，确保你已经安装了 cookiecutter。如果没有安装，可以通过以下命令进行安装：

pip3 install cookiecutter

1.2 安装 Docker Compose

接下来，安装 docker-compose。你可以参考官方文档进行安装。

1.3 创建项目

在项目目录中运行以下命令来创建项目：

cookiecutter gh:Buuntu/fastapi-react

在创建过程中，你需要输入一些变量，例如项目名称、端口号、数据库用户名和密码等。

2. 项目的使用说明

2.1 启动项目

进入项目目录后，运行以下命令来构建和启动项目：

chmod +x scripts/build.sh
./scripts/build.sh

这个脚本会构建并运行 Docker 容器，执行 Alembic 数据库迁移，并加载初始数据（包括一个测试用户）。

2.2 开发环境管理

项目构建完成后，你可以使用常规的 docker-compose 命令来管理开发环境。例如，启动容器：

docker-compose up -d

启动后，你可以通过浏览器访问 http://localhost:8000 来查看项目。

2.3 访问 API 文档

项目的 API 文档可以通过访问 http://localhost:8000/api/docs 来查看。

3. 项目API使用文档

3.1 用户管理

• 获取用户列表: GET /api/v1/users
• 获取当前用户信息: GET /api/v1/users/me
• 创建用户: POST /api/v1/users
• 更新用户: PUT /api/v1/users/{user_id}
• 删除用户: DELETE /api/v1/users/{user_id}

3.2 认证

• 登录: POST /api/v1/login/access-token
• 刷新令牌: POST /api/v1/login/refresh-token
• 登出: POST /api/v1/logout

3.3 后台任务

• 执行任务: POST /api/v1/tasks
• 任务状态: GET /api/v1/tasks/{task_id}

4. 项目安装方式

4.1 使用 Cookiecutter 创建项目

通过 cookiecutter 工具，你可以快速创建一个基于 FastAPI 和 React 的项目模板。运行以下命令：

cookiecutter gh:Buuntu/fastapi-react

4.2 手动配置

如果你不想使用 cookiecutter，也可以手动配置项目。你需要手动创建项目目录，并配置 Docker、FastAPI、React 等组件。

4.3 使用 Docker Compose

项目使用 Docker Compose 来管理开发环境。你可以通过以下命令启动项目：

docker-compose up -d

通过以上步骤，你可以顺利安装并使用 FastAPI + React 项目。希望这篇文档能帮助你更好地理解和使用该项目。

fastapi-react 🚀 Cookiecutter Template for FastAPI + React Projects. Using PostgreSQL, SQLAlchemy, and Docker 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-react