Skip to content

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

License

Notifications You must be signed in to change notification settings

equinor/template-fastapi-react

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Template Fastapi React

License On push main branch

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

Key FeaturesQuickstartDevelopmentContributing

🎯 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

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

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:

docker-compose up

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.

👍 Contributing

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