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、项目介绍

fastapi-react 是一个开源项目模板，旨在帮助开发者快速启动一个使用 FastAPI 和 React 的项目。该项目使用 PostgreSQL 作为数据库，SQLAlchemy 作为 ORM，并集成了 Docker 进行环境管理。模板提供了 JWT 认证、OAuth2 认证流程、React 前端框架等功能，使得开发者可以快速搭建一个现代化的全栈应用。

2、项目快速启动

安装依赖

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

pip3 install cookiecutter

# docker-compose 安装请参考官方文档
# https://docs.docker.com/compose/install/

生成项目

在终端中运行以下命令来生成项目：

cookiecutter gh:Buuntu/fastapi-react

输入变量

在生成项目时，你需要输入一些变量，以下是默认值：

• project_name: fastapi-react-project
• project_slug: fastapi-react-project
• port: 8000
• postgres_user: postgres
• postgres_password: password
• postgres_database: app
• superuser_email: admin@fastapi-react-project.com
• superuser_password: password
• secret_key: super_secret

启动项目

进入生成的项目目录，并启动 Docker 容器：

cd fastapi-react-project
docker-compose up --build

项目启动后，你可以通过 http://localhost:8000 访问 FastAPI 后端，通过 http://localhost:3000 访问 React 前端。

3、应用案例和最佳实践

应用案例

fastapi-react 模板适用于需要快速搭建全栈应用的场景，例如：

• 企业内部管理系统
• 个人博客或内容管理系统
• 小型电商网站

最佳实践

• 认证管理：使用 JWT 和 OAuth2 进行用户认证，确保应用的安全性。
• 代码规范：遵循 PEP 8 和 ESLint 规范，保持代码的一致性和可读性。
• 测试覆盖：编写单元测试和集成测试，确保代码的稳定性和可靠性。
• 持续集成：使用 GitHub Actions 进行持续集成，自动化测试和部署流程。

4、典型生态项目

FastAPI

FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API，基于 Python 3.7+ 标准类型提示。

React

React 是一个用于构建用户界面的 JavaScript 库，由 Facebook 开发和维护。

PostgreSQL

PostgreSQL 是一个强大的开源对象关系数据库系统，具有高度的可扩展性和可靠性。

SQLAlchemy

SQLAlchemy 是一个 Python SQL 工具包和对象关系映射器，提供了 SQL 工具和全功能的 ORM。

Docker

Docker 是一个开源的容器化平台，允许开发者将应用及其依赖打包成一个容器，实现快速部署和扩展。

通过结合这些技术，fastapi-react 模板提供了一个强大的基础，帮助开发者快速构建和部署全栈应用。

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