Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 2 KB

README.md

File metadata and controls

65 lines (42 loc) · 2 KB

FAITH Backend

Table of Contents

Technologies

Development

The backend of FAITH exposes a RESTful API that is developed using FastAPI, that is leveraged by the frontend for querying. It is advisable to use Docker for working with the backend, and if it's to be used along with the frontend, it's recommended to use Docker compose for easier development.

Pre-requisites

  1. Python: Used for development of backend with FastAPI. Installing Python usually ensures installation of pip, which can be used for package management.
  2. Docker: (optional) Supports containerization of backend for easier deployment.

Steps

Manual

  1. Ensure you have Python, pip and Docker (optional) on your system:
python --version
pip --version
docker -v
  1. Install the needed dependencies for the project after cloning the project and setting a virtual environment by the following command:
git clone https://github.com/KierthanaRS/FAITH
cd FAITH/backend
python -m venv .venv

# For Linux
source .venv/bin/activate

# For Windows
.venv\\Scripts\\Activate.ps1

  1. Configure the needed environment variables as per .env.sample file. Generate a secret for JWT to be stored under JWT_SECRET environment variable.

  2. Start the development server with the following command:

gunicorn -k uvicorn.workers.UvicornWorker -w 4 --certfile='../certs/faith.com+3.pem' --keyfile='../certs/faith.com+3-key.pem' -b localhost:8000 server:app

The backend should be accessible at https://localhost:8000

Docker

  1. Build a Docker image with the following command after configuring the necessary environment variables (assuming you're using FAITH/backend as the working directory):
docker build -t faith-backend:latest .
  1. Run the image with the following command:
docker run --network host faith-backend:latest

The backend should be accessible at http://localhost:8000