Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khaouitiabdelhakim/holyquran-js
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.
https://github.com/khaouitiabdelhakim/holyquran-js
api holy-quran islam islamic islamic-apps javascript npm quran quran-api
Last synced: 16 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/khaouitiabdelhakim/holyquran-js
- Owner: khaouitiabdelhakim
- Created: 2024-03-17T14:56:43.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-29T22:44:49.000Z (9 months ago)
- Last Synced: 2024-12-02T23:16:46.409Z (about 1 month ago)
- Topics: api, holy-quran, islam, islamic, islamic-apps, javascript, npm, quran, quran-api
- Language: JavaScript
- Homepage: https://khaouitiapps.vercel.app
- Size: 17.3 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# 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.
```
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:
```
[](https://www.buymeacoffee.com/kh.abdelhakim)
## Example Usage
```javascript
// 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
```bash
npm i holy-quran
```
### Step 2: Import in your project
```javascript
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.