Skip to content

Welcome to the FastAPI React Starter Documentation

This documentation provides a comprehensive guide to understanding, setting up, developing, and deploying projects based on the FastAPI React Starter template.

This starter template is designed to provide a modern, full-featured foundation for building web applications with a Python (FastAPI) backend and a React frontend, leveraging best practices and popular tools.

Key Features

  • Backend (FastAPI): Robust and efficient, featuring async SQLAlchemy, JWT authentication, role-based access control, structured logging, and more.
  • Frontend (React 19): Modern React with TypeScript, Vite, Tailwind CSS, shadcn/ui components, client-side routing, and custom hooks.
  • Dockerized Environment: Easy setup and consistent development/production environments using Docker Compose.
  • Database Management: Integrated Alembic migrations for schema management.
  • Automated Setup: Convenience scripts for quick environment preparation.

To get started, explore the following sections:

  • Initial Setup: Step-by-step instructions to get the project running on your local machine.
  • Development Guide: Information on project structure, coding standards, running tests, and common development tasks for both backend and frontend.
  • Make It Yours: Tips and instructions on how to customize this starter template for your own project needs.
  • Deployment: Guidelines for deploying your application to production environments.
  • Project Roadmap: An overview of planned features and future development for this starter template.

We aim to keep this documentation up-to-date and helpful. If you find any issues or have suggestions, please feel free to contribute!