cookiecutter-react-fastapi-postgres

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

Quickstart

There are two ways to start using this template. Use Option 1 to create an app for your own project. Use Option 2 to explore the template by cloning the repository and running its Makefile to create, start, and test an example app.

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

Step 1. Run Cookiecutter against the GitHub repository.

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

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

Step 2. Open the app you created.

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

make

Option 2

Step 1. Clone the repository.

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

Step 2. Change to the repository directory.

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 in VS Code. Replace <project-name> with the name of the server you created.

code build/<project-name>

Cleaning Up

To stop your app and delete its container images, enter the commands below.

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