Giter VIP home page Giter VIP logo

khaouitiabdelhakim / holyquran-js Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 17.69 MB

The HolyQuran JavaScript Library provides easy access to comprehensive Quranic data for JavaScript applications. It enables developers to seamlessly incorporate Surah details, including name, type, English name, number of verses, words, and letters, into their projects.

Home Page: https://khaouitiapps.vercel.app

JavaScript 100.00%
api holy-quran islam islamic islamic-apps javascript npm quran quran-api

holyquran-js's Introduction

HolyQuran JavaScript Library

The HolyQuran JavaScript Library provides easy access to comprehensive Quranic data for JavaScript applications. It enables developers to seamlessly incorporate Surah details, including name, type, English name, number of verses, words, and letters, into their projects.

HolyQuran

If you find this library useful or it has helped you,
please consider leaving a โญ๏ธ, or even following my GitHub account.
Your support motivates me to continue providing helpful resources.
Thank you for your appreciation! ๐ŸŒŸ๐Ÿš€๐Ÿ’–๐Ÿ˜Š๐Ÿ‘

If you'd like to support further, consider buying me a coffee:

Buy Me A Coffee

Example Usage

// Example of accessing the 3rd verse of the 4th Surah in the Holy Quran
const quran = require('holy-quran');

const hasfsHolyQuran = quran.HolyQuranHafsVersion;
const thirdVerseFourthSurah = hasfsHolyQuran[3]["verses"][2];
console.log(thirdVerseFourthSurah);

// Example of accessing the 4th english name
const englishName = hasfsHolyQuran[3]["englishName"];
console.log(englishName);
// Al-Nesaa

// Example of accessing the 3rd verse of the 4th Surah in the Holy Quran but in German
const germanHolyQuran = quran.QuranGerman;
const thirdVerseFourthSurahGerman = germanHolyQuran[3][2];
console.log(thirdVerseFourthSurahGerman);

// Und wenn ihr befรผrchtet, nicht gerecht hinsichtlich der Waisen zu handeln,
// dann heiratet, was euch an Frauen gut scheint, zwei, 
// drei oder vier. Wenn ihr aber befรผrchtet, nicht gerecht zu handeln,
//dann (nur) eine oder was eure rechte Hand besitzt. Das ist eher geeignet, daรŸ ihr nicht ungerecht seid.

Surah sample

{ "name": "ุงู„ูู„ู‚", "type": "ู…ูƒูŠู‘ุฉ", "englishName": "Al-Falak", "number": 113, "numberOfVerses": 5, "numberOfWords": 23, "numberOfLetters": 71, "verses": [ "ู‚ูู„ู’ ุฃูŽุนููˆุฐู ุจูุฑูŽุจู‘ู ุงู„ู’ููŽู„ูŽู‚ู", "ู…ูู† ุดูŽุฑู‘ู ู…ูŽุง ุฎูŽู„ูŽู‚ูŽ", "ูˆูŽู…ูู† ุดูŽุฑู‘ู ุบูŽุงุณูู‚ู ุฅูุฐูŽุง ูˆูŽู‚ูŽุจูŽ", "ูˆูŽู…ูู† ุดูŽุฑู‘ู ุงู„ู†ู‘ูŽูู‘ูŽุงุซูŽุงุชู ูููŠ ุงู„ู’ุนูู‚ูŽุฏู", "ูˆูŽู…ูู† ุดูŽุฑู‘ู ุญูŽุงุณูุฏู ุฅูุฐูŽุง ุญูŽุณูŽุฏูŽ" ] }

Features

  • Access detailed Surah information including name, type, English name, number of verses, words, and letters.
  • Retrieve specific verses of Surahs easily.
  • Translation available in 49 world languages.

Supported Languages for Translation

Russian, Chinese, Hindi, Spanish, Portuguese, Bengali, Urdu, Italian, Vietnamese, Turkish, Thai, Polish, German, Dutch, Icelandic, Hausa, Albanian, Persian, Azerbaijani, Swahili, Tajik, Tamil, Pashto, Malayalam, Malay, Sinhala, Amharic, Kurdish (Sorani), Bulgarian, Kazakh, Filipino, Sindhi, Korean, Japanese, Swedish, Norwegian, Somali, Croatian, Yoruba, Fulani, Tatar, Uyghur, Kyrgyz, Punjabi, Javanese, Telugu

Installation

Step 1: Install via npm

npm i holy-quran

Step 2: Import in your project

const quran = require('holy-quran');

Contribution

This project is open to contributions. Feel free to contribute to the development of this library by forking the repository, making your changes, and creating pull requests.

License

This project is licensed under the MIT License.

Copyright 2024 KHAOUITI ABDELHAKIM

Licensed under the MIT License
You may obtain a copy of the License at

http://opensource.org/licenses/MIT

Unless required by applicable law or agreed to in writing, software
distributed under the MIT License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the MIT License.

made with love ๐Ÿ’– - KHAOUITI Apps 2024

This README provides an overview of the HolyQuran JavaScript Library and instructions for usage, installation, and contribution.

holyquran-js's People

Contributors

khaouitiabdelhakim avatar

Stargazers

 avatar  avatar

Watchers

 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.