Full Stack FastAPI Template (Customized)

Note: This is a customized fork of the official Full Stack FastAPI Template. See the Changes from Original Template section for details.

• ⚡ FastAPI for the Python backend API.
  • 🧰 SQLModel for the Python SQL database interactions (ORM).
  • 🔍 Pydantic, used by FastAPI, for the data validation and settings management.
  • 💾 PostgreSQL as the SQL database.
• 🚀 React for the frontend.
  • 💃 Using TypeScript, hooks, Vite, and other parts of a modern frontend stack.
  • 🎨 Tailwind CSS and shadcn/ui for the frontend components.
  • 🤖 An automatically generated frontend client.
  • 🧪 Playwright for End-to-End testing.
  • 🦇 Dark mode support.
• 🐋 Docker Compose for development and production.
• 🔒 Secure password hashing by default.
• 🔑 JWT (JSON Web Token) authentication.
• 📫 Email based password recovery.
• 📬 Mailcatcher for local email testing during development.
• ✅ Tests with Pytest.
• 📞 Traefik as a reverse proxy / load balancer.
• 🚢 Deployment instructions using Docker Compose, including how to set up a frontend Traefik proxy to handle automatic HTTPS certificates.

This fork includes the following modifications from the original FastAPI template:

• Items feature removed - The example "Items" CRUD functionality has been removed from both the backend API and frontend UI, providing a cleaner starting point for your own models
• GitHub Actions removed - CI/CD workflows have been removed to allow you to set up your own pipeline

• AGENTS.md - Added AI coding agent instructions for tools like GitHub Copilot, Cursor, and other AI assistants to better understand the codebase

• Environment variables - .env is now gitignored; use .env.example as a template
• Branch naming - Default branch references changed from master to main
• Simplified Docker Compose - Streamlined configuration for easier development

You can just fork or clone this repository and use it as is.

git clone git@github.com:DaniV3611/full-stack-fastapi-react-template.git my-project
cd my-project
cp .env.example .env  # Copy and configure your environment variables

If you want to pull updates from the original FastAPI template:

# Add the original template as upstream (one-time setup)
git remote add upstream git@github.com:fastapi/full-stack-fastapi-template.git

# Pull latest changes
git pull --no-commit upstream master

Note: Since this fork has removed some features, you may encounter conflicts when merging updates from the original template.

You can update configs in the .env file to customize your configurations.

Before deploying it, make sure you change at least the values for:

• SECRET_KEY
• FIRST_SUPERUSER_PASSWORD
• POSTGRES_PASSWORD

You can (and should) pass these as environment variables from secrets.

Read the deployment.md docs for more details.

Some environment variables in the .env file have a default value of changethis.

You have to change them with a secret key, to generate secret keys you can run the following command:

python -c "import secrets; print(secrets.token_urlsafe(32))"

Copy the content and use that as password / secret key. And run that again to generate another secure key.

Backend docs: backend/README.md.

Frontend docs: frontend/README.md.

Deployment docs: deployment.md.

General development docs: development.md.

This includes using Docker Compose, custom local domains, .env configurations, etc.

Check the file release-notes.md.

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

This project is a customized fork of the Full Stack FastAPI Template by @tiangolo and the FastAPI team.