https://github.com/mohamedashraf701/npm_quran_sharif
this npm package provides a comprehensive collection of the Quran in both English and Arabic translations.
https://github.com/mohamedashraf701/npm_quran_sharif
Last synced: 3 months ago
JSON representation
this npm package provides a comprehensive collection of the Quran in both English and Arabic translations.
- Host: GitHub
- URL: https://github.com/mohamedashraf701/npm_quran_sharif
- Owner: MohamedAshraf701
- License: mit
- Created: 2023-07-06T06:26:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-10T10:50:29.000Z (almost 2 years ago)
- Last Synced: 2025-03-07T05:34:56.648Z (3 months ago)
- Language: JavaScript
- Size: 1.81 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quran Sharif
[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-download-url]
[![MIT License][license-image]][license-url]
A utility package for working with the Quran in JavaScript.
## Features
- Retrieve all surahs from the Quran.
- Get a specific surah by ID.
- Retrieve a list of surah names.
- Filter surahs by revelation type.
- Fetch ayahs by Juz ID.
## Installation
Install the package using npm:
```shell
npm install quran_sharif
```
## Usage
Import the package into your JavaScript file:
```javascript
const quran = require('quran_sharif');
```
Use the provided methods to access the Quran data:
```javascript
// Retrieve all surahs
const allSurahs = quran.getAllSurah();
// Get surah by ID
const surah = quran.getSurahById({ id: 1 });
// Get a list of surah names
const surahNames = quran.getSurahName();
// Filter surahs by revelation type
const makkiSurahs = quran.getSurahByRevelationType({ isMakki: true });
// Get ayahs by Juz ID
const juzAyahs = quran.getJuz({ id: 1 });
```
For more details on each method and its usage, refer to the API documentation.
## Examples
You can find usage examples in the [examples](https://github.com/MohamedAshraf701/npm_quran_sharif/tree/main/) folder of this repository.
## API Documentation
The API documentation for this package can be found [here](https://github.com/MohamedAshraf701/npm_quran_sharif/tree/main/).
## License
This project is licensed under the [MIT License](https://zaid.digital).
## Contributing
Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.
## Author
This package is authored and maintained by [zaid.digital](https://zaid.digital).
## Get in touch
If you have any questions, feel free to reach out:
- Email: [email protected]
- GitHub: [@MohamedAshraf701](https://github.com/MohamedAshraf701)
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: LICENSE
[npm-url]: https://npmjs.org/package/quran_sharif
[npm-version-image]: https://img.shields.io/npm/v/quran_sharif.svg?style=flat
[npm-downloads-image]: https://img.shields.io/npm/dm/quran_sharif.svg?style=flat
[npm-download-url]: https://npmcharts.com/compare/quran_sharif?minimal=true