Quran Tafseer REST APIs and Quran Text
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data_text
docs
dump_data
heroku
locale
quran_tafseer
quran_text
requirements
static
tafseer_api
.coveragerc
.env
.gitignore
.travis.yml
Dockerfile
LICENSE
Procfile
README.md
changelog.md
db.sqlite3
manage.py
requirements.txt
runtime.txt
setup.cfg

README.md

Quran Tafseer API Build Status codecov

Quran Tafseer REST APIs and Quran Text

Idea

The idea is to create one REST API for all Quran Tafseer/Interpretation for developers. The idea came to me when I tried to search for REST API for Quran Tafseer/Interpretation I couldn't find one, and each Quran application web/mobile has its own Quran Tafseer/Interpretation, so I thought it's a good idea to create one.

How to contribute and help the project

  1. Report Bugs
    • If you found a bug please report, it'll help the project to grow and improve.
  2. Suggest Ideas
    • If you have an innovative idea you feel it'll be awesome to add to the API, please share.
  3. Use the API
    • Yes using the API will help the project, this is the reason I built this API 😉.
  4. Spread the word
    • Share the API with your friends and community.
  5. Write a wrapper or client for the API.
    • Please find the client list below.
  6. Donate
    • You can help me in growing the project with any amount.
  7. Check translation help label, and help in documentation translation.
  8. Check help wanted label, and help in developing the API.

Development Stack

  1. Python
  2. Django
  3. Django REST Framework

How to run locally

  • Create a virtualenv mkvirtualenv tafsser_api
  • Install dependencies pip install -r requirements/requirements_dev.txt
  • Create .env file and add project settings
Setting Example
DEBUG DEBUG=True
SECRET_KEY SECRET_KEY=VeryVerySecret
DATABASE_URL DATABASE_URL=sqlite:///db.sqlite3
  • Run model migrations python manage.py migrate
  • Run development server python manage.py runserver

Clients

Quran Tafseer/Interpretation Sources

Tafseer Soruce Language
التفسير الميسر Tanzil.net العربية
تفسير الجلالي Tanzil.net العربية
تفسير السعدي Ayat العربية
تفسير ابن كثير Ayat العربية
تفسير الوسيط لطنطاوي Ayat العربية
تفسير البغوي Ayat العربية
تفسير القرطبي Ayat العربية
تفسير الطبري Ayat العربية
Arberry Tanzil.net English
Yusuf Ali Tanzil.net English
Keyzer Tanzil.net Dutch
Leemhuis Tanzil.net Dutch
Siregar Tanzil.net Dutch