README.md

Full Stack FastAPI Template

Technology Stack and Features

• ⚡ 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.
  • 🧩 Built into the backend application and served by FastAPI on the same domain as the API.
  • 💃 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.
• ☁️ FastAPI Cloud for deployment.
• 🐋 Docker Compose for local services and self-hosted deployment.
  • 📞 Traefik as a reverse proxy with automatic HTTPS.
• 🔒 Secure password hashing by default.
• 🔑 JWT (JSON Web Token) authentication.
• 📫 Email-based password recovery.
• 📬 Mailcatcher for local email testing during development.
• ✅ Tests with Pytest.
• 🏭 CI (continuous integration) and CD (continuous deployment) based on GitHub Actions.

Dashboard Login

Dashboard - Admin

Dashboard - Items

Dashboard - Dark Mode

Interactive API Documentation

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.