Skip to content

mzkarami/mvp-template

Repository files navigation

MVP Template: FastAPI, React (Next.js), and Postgres

This repository is a production-ready template for building a Minimum Viable Product (MVP). It provides a solid architectural foundation for a modern web application, allowing you to focus on building your product's unique features from day one.

Getting Started

Prerequisites

  1. Docker & Docker Compose: Install Docker.
  2. Node.js & pnpm: Install pnpm.
  3. Python: The backend uses Python 3.12+.

1. Generate Frontend Lockfile (Critical First Step)

Before running the Docker build, you must generate the pnpm-lock.yaml file. This file is essential for ensuring reproducible builds inside and outside of Docker.

Navigate to the frontend directory and run the install command:

cd frontend
pnpm install
cd ..

This will create the pnpm-lock.yaml file in the frontend directory. Commit this file to your repository.

2. Set Up Environment Variables

Copy the example environment file to create your local configuration:

cp example.env .env

3. Run the Application

With the lockfile generated and the .env file in place, you can now build and run the entire stack:

docker-compose up --build
  • Backend API will be available at http://localhost:8000
  • Frontend App will be available at http://localhost:3000

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published