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…

Что это такое?Шаблон полноценного веб-приложения, который объединяет бэкенд на Python FastAPI, фронтенд на React/TypeScript, базу данных PostgreSQL и Docker Compose. Аутентификация, админ-панель и настройки развёртывания уже подключены.
Это библиотека, которую нужно установить, или проект, который нужно скопировать?Это шаблон репозитория на GitHub: нажмите «Use this template», чтобы создать собственную копию репозитория. Это не пакет, который устанавливается через pip или npm.
Как запустить это у себя?Нажмите «Use this template», чтобы создать свой репозиторий, затем следуйте отдельным инструкциям backend/README.md и frontend/README.md для локальной разработки. Всё запускается через Docker Compose.
Что нужно установить перед запуском: Python, Node, Docker?Нужен Docker Compose, чтобы поднять локальные сервисы, такие как Postgres, Traefik и Mailpit. Также понадобится Python для бэкенда на FastAPI и набор инструментов JS/TS (Vite) для фронтенда на React.
Есть ли подводные камни, прежде чем я начну создавать на этом реальный проект?Во фронтенде есть автоматически генерируемый API-клиент. Каждый раз, когда вы меняете эндпоинты бэкенда, нужно заново генерировать этот клиент, чтобы фронтенд и бэкенд оставались синхронизированы.
Где это реально работает: только локально или я могу это развернуть?Для разработки это работает локально через Docker Compose. Развернуть можно либо в FastAPI Cloud, либо на своём сервере с Docker Compose за Traefik, который отвечает за проксирование и автоматический HTTPS.
Что входит в админ-панель из коробки?Готовая панель с входом в систему, управлением пользователями и экранами для работы с элементами, а также встроенная поддержка тёмной темы.
Как здесь устроена аутентификация?По умолчанию используется аутентификация на основе JWT с надёжным хешированием паролей, а также восстановление пароля через электронную почту.
Как тестируют письма во время разработки?Mailpit локально перехватывает исходящие письма, так что вы можете просматривать шаблоны React Email (например, для восстановления пароля) без настоящего почтового сервера.
Что отвечает за тестирование и CI/CD?Playwright выполняет сквозные тесты, а Pytest — тесты бэкенда. Оба подключены к GitHub Actions для непрерывной интеграции и развёртывания.
Creator
fastapi
Size
6.9 MB
Stars
46K
Age
7y
Commits · 90 Days