Giter VIP home page Giter VIP logo

al-quran-api's Introduction

Al-Quran API

RESTful Quran API with original Arabic text, English Translation, transliteration, Verse Search, Surah Search and Word Search in corpus in plain JSON.

Web Data Extraction

Web-Scraped from al-quran.info [Python Script used Included in ./quran-scraping] Entire Quran in JSON in ./quran-scraping/AL-QURAN_WITH_TRANSLATION_AND_TRANSLITERATION.json

Install dependencies

npm install

Running in development

npm run dev

Running in production

npm start

Runs on localhost:3000 by default but can be configured using the PORT environment variable.

Running tests

npm test

# Watch repo
npm run test:watch

API Endpoints

  • / Responds with JSON including some properties of the Quran. (deprecated)

  • /:surah Possible values: 1-114 Responds with entire Surah/Chapter of the Quran including all verses in the Surah and some additional information.

  • /:surah/:verse For a specific Ayah/Verse in a specific Surah along with original Arabic text, translation, transliteration and verse ID

  • /:surah/:range Get a range (collection) of verses within valid limits of chapters and verse numbers. e.g: /1/1-5

  • /:surah/:keyword Looks for a given keyword (English) in translation_eng key in the entire Quran and responds with all the verses containing the given keyword in JSON

  • /corpus/:keyword Looks for a given keyword (English) in translation_eng key in the entire Quran and responds with all the verses containing the given keyword in JSON

Contribute

Due to the nature of scraping from web, the JSON Quran contains unnecessary information and references which are of no use to me. Feel free to edit and remove those :)

al-quran-api's People

Contributors

rzgry avatar dependabot[bot] avatar raz0229 avatar matheusrich avatar rwalter215 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.