full-stack-fastapi-template README

The project's README from github.com/fastapi/full-stack-fastapi-template. As one markdown file: README.md.

Full Stack FastAPI Template

Test Docker Compose Test Backend

Technology Stack and Features

Dashboard Login

Dashboard login screenshot

Dashboard - Admin

Admin dashboard screenshot

Dashboard - Items

Items dashboard screenshot

Dashboard - Dark Mode

Dark mode dashboard screenshot

React Email Templates

Email templates screenshot

Mailpit - Local Email Testing

Mailpit screenshot

Interactive API Documentation

API docs

How to Use It

Click the Use this template button at the top of this page to create a new repository.

Backend Development

Backend docs: backend/README.md.

Frontend Development

Frontend docs: frontend/README.md.

Deployment

FastAPI Cloud deployment: deployment.md.

Self-hosted deployment with Docker Compose: deployment-docker-compose.md.

Development

General development docs: development.md.

This includes the local FastAPI and Vite workflow, Docker Compose services, .env configuration, and more.

Release Notes

Check the file release-notes.md.

License

The Full Stack FastAPI Template is licensed under the terms of the MIT license.

full-stack-fastapi-template (fastapi/full-stack-fastapi-template)

Searching Database…

What is this?A full-stack web application template that bundles a FastAPI Python backend with a React/TypeScript frontend, a PostgreSQL database, and Docker Compose, giving you authentication, an admin dashboard, and deployment config already wired up.
Is this a library I install, or a project I copy?It's a GitHub repository template: you click 'Use this template' to create your own copy of the repo, not a package you install with pip or npm.
How do I get this running?Click 'Use this template' to create your own repo, then follow the separate backend/README.md and frontend/README.md guides for local development, which run through Docker Compose.
What do I need installed before trying this — Python, Node, Docker?You need Docker Compose to spin up local services like Postgres, Traefik, and Mailpit, plus Python for the FastAPI backend and a JS/TS toolchain (Vite) for the React frontend.
Any catches before I build a real project on this?The frontend ships with an automatically generated API client, so every time you change backend endpoints you need to regenerate that client to keep frontend and backend in sync.
Where does this actually run — just locally, or can I deploy it too?It runs locally via Docker Compose for development, and can be deployed either to FastAPI Cloud or self-hosted with Docker Compose behind Traefik, which handles reverse proxying and automatic HTTPS.
What does the admin dashboard include out of the box?A working dashboard with login, user administration, and item management screens, plus built-in dark mode support.
How does authentication work here?It uses JWT-based auth with secure password hashing by default, plus an email-based password recovery flow.
How are emails tested during development?Mailpit captures outgoing emails locally so you can preview the React Email templates (like password recovery) without a real mail server.
What handles testing and CI/CD?Playwright covers end-to-end tests and Pytest covers backend tests, both wired into GitHub Actions for continuous integration and deployment.
Creator
fastapi
Size
6.9 MB
Stars
46K
Age
7y
Commits · 90 Days