الْحَمْدُ لِلَّهِ رَبِّ الْعَالَمِينَ
This repository contains the source code of al-quran.reflectslight.io - a static website for reading (and listening to) The Noble Quran. After the website is built, the build directory consists of HTML, CSS, JavaScript and other static assets that can be hosted by a web server such as nginx, apache, et cetera.
The following languages and tools have to be installed to build the website from source:
- Ruby 3.2 (or later)
- NodeJS v18.15 (or later)
- tidy-html5
The following tools are used during the generation of the website's favicons. The favicons generally do not change and unless you're working with the favicons directly you won't need to install these tools:
- rsgv-convert via libsvg2
- convert via ImageMagick
# Clone repository
git clone https://github.com/ReflectsLight/al-quran.reflectslight.io
cd al-quran.reflectslight.io
# Setup build environment
bin/setup
# List all tasks
bundle exec rake -T
# Build website (dev build)
bundle exec rake nanoc:build
# Build website (production build)
bundle exec rake nanoc:build[production]
# Start web server
bundle exec rake server
server.base_url
If you plan to host the website on
your own domain you should update
nanoc.yaml
first. In certain places links will reference
https://al-quran.reflectslight.io
instead of using a relative path. For example
/src/sitemap.xml.erb
is one such place. Those links can be updated
to your own domain by changing the server.base_url
field in
nanoc.yaml
before running bundle exec rake nanoc:build.
audio.base_url
audio.base_url controls what web server serves
audio content.
The default
works out of the box. The URL for an audio file is
resolved by joining audio.base_url and
/<surahid>/<ayahid>.mp3. The audio.base_url option
makes it relatively easy to change the reciter
at build time, before deploying the website.
The https://al-quran-audio.reflectslight.io endpoint provides the following recitations:
- Mishari bin Rashed Alafasy
https://al-quran-audio.reflectslight.io/alafasy - Ahmad bin Ali Al-Ajmi
https://al-quran-audio.reflectslight.io/alajmi - Sahl Yassin
https://al-quran-audio.reflectslight.io/yassin - Hani ar-Rifai
https://al-quran-audio.reflectslight.io/rifai
Due to their overall size the audio files are the only files not kept in this repository. The audio files are hosted by https://al-quran-audio.reflectslight.io instead.
Translations
- English (The Clear Quran) by Dr. Mustafa Khattab
- Farsi by Hussain Ansarian
Recitations
- Mishari bin Rashed Alafasy
- Ahmad bin Ali Al-Ajmi
- Sahl Yassin
- Hani ar-Rifai
Misc
- Credit to the graphic artists:
The "source code" is released under the terms of the GPL
See LICENSE for details