al-quran.reflectslight.io/README.md
2024-08-27 20:45:54 -03:00

3.1 KiB

About

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.

Requirements

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

Development

# 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

Configuration

Thanks

الْحَمْدُ لِلَّهِ رَبِّ الْعَالَمِينَ

  • Thanks to the graphic artists:
  • Thanks to the translators:
    • English (The Clear Quran) by Dr. Mustafa Khattab
    • Farsi by Hussain Ansarian
  • Thanks to the reciters:
    • Mishari bin Rashed Alafasy
    • Ahmad bin Ali Al-Ajmi
    • Sahl Yassin
    • Hani ar-Rifai

License

The "source code" is released under the terms of the GPL
See LICENSE for details