Code Monkey home page Code Monkey logo

tafseer_api's Introduction

Quran Tafseer API Codeship Status for Quran-Tafseer/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

tafseer_api's People

Contributors

emadmokhtar avatar dependabot[bot] avatar emad-elsaid avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.