README
The Amazing Quran | Images
بسم الله الرحمن الرحيم
This node module allows you to easily retrieve png of an ayah of the Quran
No database is required, you just need to have node installed !
How to use ?
Installation
This repository contains images of the holly Quran in png format, and a small node module to handle them
<script type="module">
import theAmazingQuranImages from 'https://cdn.skypack.dev/the-amazing-quran-images';
</script>
بسم الله الرحمن الرحيم
This node module allows you to easily retrieve png of an ayah of the Quran
No database is required, you just need to have node installed !
gt; npm install the-amazing-quran-images
This function allows you to retrieve the path of the png file
getAyahPath(surahNumber, ayahNumber)
This function return a string of the path of the ayah wanted
var quranImgManager = require('the-amazing-quran-images')();
// Get png of first ayah of surah al baqarah
quranImageManager.getAyahPath(2, 1);
This function allows you to retrieve a base64 string of an ayah from the Quran
getAyahBase64(surahNumber, ayahNumber)
This function return a string containing the base64 value of the ayah in png
var quranImgManager = require('the-amazing-quran-images')();
// Get png of first ayah of surah al baqarah
quranImageManager.getAyahBase64(2, 1);
Each ayah image are in the images directory. Each ayah in png come from http://www.everyayah.com/data/quranpngs/
Here is a none exhaustive list of features that can be implemented
The source code is in the src directory.
Since the module is develop in ES6, a simple gulp task using Babel.js convert it in ES5.
This module is open source. You can use, share, copy, modify and distribute this app as you want as long as you don't have a bad purpose
If you find any issues on this project, please report on the issue section of github or send an email to captainyouz@gmail.com