Code Monkey home page Code Monkey logo

quran-api's Introduction

quran-api

allahuma saliy ealaa sayidina muhamad, the quri-api is a python web application that provides a simple and easy way to access the quran api.

Features

  • simple and easy to use and easy to understand
  • you can find all the quran surahs and verses
  • you can find & add your favorite reciters and listen to their recitations
  • you can find azkar with categories
  • you can find the quran translation

Configuration

First make directory as name instance in your project directory.

Then create a file named config.py in the instance directory.

# config.py
SECRET_KEY = "any string to secret your app"
ALLOW_HOSTS = ["*"]
DOMAIN = "http://localhost:5000"  # like https://cdn.fdrbot.com

Installation

First, you need to clone porject from github.

git clone https://github.com/DwcTeam/quran-api.git

Then, you need to install all the dependencies.

pip install -r requirements.txt  # Windows
pip3 install -r requirements.txt  # Linux / MacOS

Then, you need to run the server.

python app.py  # Windows
python3 app.py  # Linux / MacOS 
  • Optional: you can install the server with pip install gunicorn & run it with gunicorn app:app -b="host:port" replace host:port with your host and port or run gunicorn app:app.

After that, you need to install a cdn files to your server. from this link Google Drive and copy the reciters.rar file to your server to cdn/reciters and unrar it.

Routes

  • / - States the root of the application & is allow host.
  • /moshaf/:page_number.png - Get the page image of the moshaf.
  • /reciters/:reciter_name/:surah_number.mp3 - Get the recitation of the surah.

Copyright

All copyright belongs to the HazemMeqdad and DwcTeam.

quran-api's People

Contributors

hazemmeqdad avatar

Stargazers

 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.