cookiecutter-react-fastapi-postgres

A cookiecutter template for creating a full-stack app consisting of a React frontend, FastAPI backend, and PostgreSQL database.

Quickstart

The instructions below assume you have or will get the following software installed: Make, Docker, uv, Ruff, Semgrep, TruffleHog, Hadolint, Syft, Grype, yq, and cookiecutter. Ruff, Semgrep, TruffleHog, Hadolint, Syft, and Grype are used in our development workflow to help identify and reduce security risks introduced by this cookiecutter template.

Option 1

Start here if you want to jump into creating an app without exploring the cookiecutter template first.

Step 1. Run cookiecutter against this repository.

cookiecutter https://github.com/deathlabs/cookiecutter-react-fastapi-postgres.git

When prompted, either accept the default values or provide your own.

Step 2. Change directories to the app you just you created.

Step 3. Use the Makefile to create, start, and test your app.

make

Option 2

Start here if you want to explore the cookiecutter template before using it on a real project.

Step 1. Clone the repository.

git clone https://github.com/deathlabs/cookiecutter-react-fastapi-postgres.git

Step 2. Change directories to the repository you just downloaded.

cd cookiecutter-react-fastapi-postgres

Step 3. Use the Makefile to create, start, and test an example app. The Makefile places the created app in the build folder, in a subfolder named after the server.

make

Step 4. Open the created app (replace <project-name> with the actual name of your project).

cd build/<project-name>

Cleaning Up

To stop your app and delete its container images, enter the commands below from the root directory of your project.

make stop-containers
make remove-containers
make remove-container-images