nyeker / quran-api Goto Github PK

This project is made for developers who want to develop Islamic applications. besides that this project also aims to be a charity for developers who develop applications with this API, especially me and the developers from the data sources that I get.

• Introduction

• Installation

• Usage/Endpoint

• Data Resources

This API was created to make it easier for developers to develop Islamic applications. There are several different recitations so that developers can create dynamic audio. The data used in the development of this API is taken from several different sources, both from existing APIs and from scraping results.

This API was created using the Express Web Application Framework and several additional libraries that you can see in the package.json file.

File Structure :

Quran-API
├── __test__/
├── data/
│	├── imam.json
│	└── quran.json
├── server/
|	├── app.js
|	├── controller.js
|	├── middleware.js
|	└── routes.js
├── static/
├── util/
├── package.json
└── package-lock.json

⬆️ Back to Top

There are several different ways to do the installation, you can use whichever you like

• Localhost

  # clone the repository
  > git clone https://github.com/rzkytmgr/Quran-API.git quran-api
  
  # change directory
  > cd quran-api
  
  # install all packages from package.json
  > npm install
  
  # now, you can start it
  > npm start

• Heroku Deploy

  you can do it with just one click. But you must have a Heroku account.

  

• Vercel Deploy

  click the deploy button below. Register your own vercel account

  

Note : if you have problems with installation, feel free to create an issue.

⬆️ Back to Top

Some of these API endpoints that you can access, start the application on your local computer or for a demo, you can go to the following link Qur'an Endpoint

• /imam/:id

  Displays list of imam

  params :

  [Optional] id : Spesific imam id

  query :

  example :

  # display all imam
  > curl -v -H "Content-Type: application/json" \
  > http://quran-endpoint.herokuapp.com/imam
  
  # display spesific imam
  > curl -v -H "Content-Type: application/json" \
  > http://quran-endpoint.herokuapp.com/imam/2

• /quran/:surah/:ayah?imamId=

  Display list of surah in qur'an

  params :

  [Optional] surah : spesific surah in qur'an

  [Optional] Ayah : Spesific Ayah in qur'an surah

  query :

  [Optional] imamId : Spesific imam id, get it from /imam

  example :

  # show all qur'an surah (without ayah)
  > curl -v -H "Content-Type: application/json" \
  > http://quran-endpoint.herokuapp.com/quran
  
  # show spesific qur'an surah (with ayah)
  > curl -v -H "Content-Type: application/json" \
  > http://quran-endpoint.herokuapp.com/quran/12
  
  # show spesific ayah in a surah
  > curl -v -H "Content-Type: application/json" \
  > http://quran-endpoint.herokuapp.com/quran/12/4
  
  # note :
  #	you can add the ?imamId= query wherever you want,
  # e.g :
  #	/quran?imamId=2
  #	/quran/12?imamId=10
  #	/quran/12/4?imamId=6

  Note : if you have problems with Usage/Endpoint, feel free to create an issue.

⬆️ Back to Top

all the data in this api is obtained from several sources below

• Kemenag RI
• quran/quran.com-api
• sutanlab/quran-api
• islamic-network/api.alquran.cloud
• quranicaudio.com
• everyayah.com

⬆️ Back to Top

Thank you,

@rzkytmgr