Bible Helper API

A comprehensive Bible Helper API built with FastAPI, designed to offer a variety of faith-based tools.

Features

Core Functionalities

• 📖 Daily Devotional
• 🔍 Search Bible Verses
• 🎲 Random Bible Verse
• ❓ Bible Quiz
• 🙏 Prayer Requests

Extra Functionalities

• 🗓️ Bible Reading Plan
• 📌 Bookmarks & Notes
• 🎧 Audio Bible Support
• 📆 Bible Event Calendar
• 🏅 Bible Streaks & Achievements
• 📬 Daily Notification Scheduler
• 👥 Accountability Partner Matching

Tech Stack

• FastAPI
• SQLAlchemy
• Pydantic
• JWT Authentication
• SQLite/PostgreSQL
• Alembic (migrations)

Getting Started

Prerequisites

• Python 3.8+
• pip

Installation

1. Clone the repository

git clone https://github.com/yourusername/bible_help.git
cd bible_help

2. Create a virtual environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies

pip install -r requirements.txt

4. Run the application

uvicorn app.main:app --reload

5. Access the API documentation

http://localhost:8000/docs

API Documentation

Detailed API documentation is available at /docs or /redoc endpoints when the server is running.

License

This project is licensed under the MIT License - see the LICENSE file for details.