Baiboly FastAPI Application

This FastAPI application is designed to serve JSON data sourced from the Baiboly JSON Repository, a comprehensive dataset of the Malagasy Bible (Baiboly). The application utilizes a custom API to efficiently fetch and process the JSON data, allowing users to access structured Bible content, including books, chapters, and verses.

The API is specifically designed to order the Bible chapters and verses based on the metadata within the dataset, ensuring accurate representation of the Bible's structure. This enables seamless navigation through the chapters and verses, and provides an organized, user-friendly interface for interacting with the Malagasy Bible content.

demo.mp4

Contents

Installation | Classical Run | Local Docker Container | Pull from Dockerhub

How to Run

• Clone the Repository

  git clone https://github.com/h471x/baiboly_json.git

• Navigate to the Project Directory

  cd baiboly_json

Classical Run

• Create a Virtual Environment

  python -m venv baiboly

• Activate the Virtual Environment

  • Windows (PowerShell):

    .\baiboly\Scripts\Activate.ps1

  • Windows (CMD):

    .\baiboly\Scripts\activate

  • Linux/Mac:

    source baiboly/bin/activate

• Install Dependencies

  pip install -r requirements.txt

• Run the Application

  python main.py

Run as Docker Container (Local)

• Build the Docker Image

  docker build -t baiboly-fastapi .

• Run the Docker Container

  docker run -p 8000:8000 baiboly-fastapi

• Access the API
  Open your browser or API client and navigate to http://localhost:8000.

Run from Docker Hub

• Pull the Image from Docker Hub

  docker pull hatixntsoa/baiboly-fastapi:v0.1.0

• Run the Container

  docker run -p 8000:8000 hatixntsoa/baiboly-fastapi:v0.1.0

• Access the API
  Open your browser or API client and navigate to http://localhost:8000.