FastAPI Project Setup Guide

If you find this project useful, please consider giving it a star on GitHub! It helps others discover this project and motivates further development.

Prerequisites

Ensure you have the following installed:

• Python 3.8+
• pip (Python package manager)
• virtualenv (optional but recommended)

---

🚀 Setup Instructions

1️⃣ Clone the Repository

git clone https://github.com/yashsinghviwork/fastapi-boilerplate.git
cd fastapi-boilerplate

2️⃣ Create a Virtual Environment

Windows

python -m venv venv
venv\Scripts\activate

Linux / macOS

python3 -m venv venv
source venv/bin/activate

3️⃣ Install Dependencies

pip install -r requirements.txt

---

💻 Running the Server

A uvicorn_config.py file is already included for configuring Uvicorn. Run the following command to start the server:

python uvicorn_config.py

---

🔧 Environment Variables

You can configure environment-specific settings using a .env file.

Create a .env file in the project root:

APP_NAME=FastAPI App
DEBUG=True
HOST=0.0.0.0
PORT=8000

---

✅ API Documentation

Once the server is running, access the API docs:

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc