Template Fastapi React

This is a solution template for creating a Single Page App (SPA) with React and FastAPI following the principles of Clean Architecture.

Key Features • Quickstart • Development • Contributing

🎯 Key features

• Clean architecture
• Screaming architecture
• Auto-generated changelogs
• Auto-generated OpenAPI specification
• Automatic documentation of REST API
• Auto-generated REST API clients
• Pre-commit hooks
• Pydantic data validation

⚡ Quickstart

Prerequisites

The minimum requirements to run the application locally are:

• Docker and Docker Compose

Configuration

Environment variables is used for configuration and must be set before running.

Create a copy of .env-template called .env and populate it with values:

• XYZ: Specifies the [RESOURCE NAME] connection string

Note: The template doesn't have any values that you need to replace, but any instantiated project probably will.

Running

Once you have done the configuration, you can start running:

docker compose up --build

The application will be served at http://localhost

The API documentation can be found at http://localhost:5000/docs

💫 Development

See the docs if you want to start developing.

Or run the docs locally:

mise run docs-serve

👍 Contributing

Thanks for your interest in contributing! There are many ways to contribute to this project. Get started here.