https://github.com/equinor/template-fastapi-react

A solution template for creating a Single Page App (SPA) with React and FastAPI following the principles of Clean Architecture.
https://github.com/equinor/template-fastapi-react

boilerplate clean-architecture cleanarchitecture fastapi python react

Last synced: 6 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/equinor/template-fastapi-react
• Owner: equinor
• License: mit
• Created: 2022-06-04T15:33:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-20T07:50:18.000Z (16 days ago)
• Last Synced: 2025-01-23T09:07:16.180Z (13 days ago)
• Topics: boilerplate, clean-architecture, cleanarchitecture, fastapi, python, react
• Language: Python
• Homepage: https://equinor.github.io/template-fastapi-react
• Size: 203 MB
• Stars: 67
• Watchers: 2
• Forks: 12
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        




# Template Fastapi React

[![License][license-badge]][license]

[![On push main branch][on-push-main-branch-badge]][on-push-main-branch-action]

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

[Key Features](#key-features)•

[Quickstart](#quickstart) •

[Development](#development) •

[Contributing](#contributing)





## :dart: 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



## :zap: Quickstart

### Prerequisites

In order to run the commands described below, you need:

- [Docker](https://www.docker.com/)

- [Docker Compose](https://docs.docker.com/compose/)

- Make sure you have Python installed. version 3.10 or higher is required.

### 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.

- `XXX`: Specifies the directory in which the database is stored.

### Running

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

```sh

docker-compose up

```

The application will be served at http://localhost

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



## :dizzy: Development

See the [docs](https://equinor.github.io/template-fastapi-react/) if you want to start developing.



## :+1: Contributing

Thanks for your interest in contributing! There are many ways to contribute to this project. Get started [here](CONTRIBUTING.md).

[license-badge]: https://img.shields.io/badge/License-MIT-yellow.svg

[license]: https://github.com/equinor/boilerplate-clean-architecture/blob/main/LICENSE

[releases]: https://github.com/equinor/boilerplate-clean-architecture/releases

[on-push-main-branch-badge]: https://github.com/equinor/boilerplate-clean-architecture/actions/workflows/on-push-main-branch.yaml/badge.svg

[on-push-main-branch-action]: https://github.com/equinor/boilerplate-clean-architecture/actions/workflows/on-push-main-branch.yaml