Overview

❌ THIS IS A WORK IN PROGRESS! The API is not currently available for consumption. Development work is ongoing.

This project will eventually allow consuming a Hadith API built on python's flask framework.

python 3+ is required to run the project.

Package Structure

├── README.md
├── main.py
├── Dockerfile

Please follow the instructions below

git clone REPO
cd REPO
pip install -r requirements.txt
python main.py

Build using:

$ docker build -t sunnah-com/api .

Run with:

$ docker run --init -p 5000:5000 sunnah-com/api

You can then visit localhost:5000 to verify that it's running on your machine. Or, alternatively:

$ curl http://localhost:5000

Retrieves list of all collections

Retrieves a single collection by id

Retrieves list of all hadith in a given collection and book