dheemanthbhat / fastapi-mongodb-boilerplate

FastAPI+MongoDB Boilerplate Code

FastAPI+MongoDB Boilerplate Code

1 About

fastapi-mongodb-boilerplate is a boilerplate code containing REST APIs developed using FastAPI and MongoDB as database.

2 Technical Specifications

2.1 Technologies

Below are the list of technologies used in this project:

1. Python - Programming language (version >= 3.11).
2. FastAPI - Python Web framework used in Backend API development.
3. MongoDB - NoSQL Database for storing data.
4. Docker - Containerizing the services.

2.2 Libraries

Libraries used in this project:

1. PyMongo - Native Python driver for MongoDB.
2. Motor - Asynchronous Python driver for MongoDB built on top of PyMongo.
3. Prisma - ORM (or ODM) for Python and MongoDB.

3 Setup

This project can be setup in two ways.

3.1 Local setup

Steps to setup fastapi-mongodb-boilerplate on your local machine.

STEP 1: Clone repository

Clone this repository and traverse to the project folder using below commands:

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

STEP 2: Setup virtual environment

Create and activate virtual environment.

Windows

python -m venv .venv
.venv\Scripts\activate

Linux

python -m venv .venv
source .venv/bin/activate

STEP 3: Install python packages

pip install -r requirements.txt

STEP 4: Setup Environment variables

1. Create duplicate of .env.sample file and rename it to .env.
2. Update environment variables with proper values based on your requirements.
3. For example change MONGO_CONNECTION_STRING to a valid MongoDB Atlas URL.

STEP 5: Start web server

uvicorn src.main:app --reload

3.2 Container setup

To setup fastapi-mongodb-boilerplate using Docker, open Docker Desktop and run below command.

docker-compose up -d

4 API docs

4.1 Swagger docs

Launch Swagger docs in browser: http://127.0.0.1:8000/docs

4.2 Redoc

Launch Redoc docs in browser: http://127.0.0.1:8000/redoc