al-quran.reflectslight.io/README.md

About

This repository contains the source code of al-quran.reflectslight.io, a static website for reading The Quran. After the website is built, the build directory consists of HTML, CSS, JavaScript and other static assets that can be hosted by a regular web server (eg nginx, apache, etc).

Stack

The following languages and tools have to be installed before the website can be built:

• Ruby 3.1, or later.
• NodeJS v18.15, or later.
• tidy-html5
  There is a good chance there's a package available for tidy-html5 on your operating system of choice.

Local development

1. Clone

git clone https://github.com/ReflectsLight/al-quran.git
cd al-quran

2. Install Ruby, NodeJS packages

bundle install
npm i

3. Build website

# Build once
rake build

# Build whenever a change is detected
rake build:watch

4. Start server on localhost

rake server

Thanks

First and foremost, Alhamdulillah.

• Thanks to the following graphic artists:

  • /src/favicon.png by Aficons.
  • RefreshIcon by Muhammad Haq.

• Thanks to the following translators:

  • English (The Clear Quran) by Dr. Mustafa Khattab