ReflectsLight/al-quran.reflectslight.io
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
al-quran.reflectslight.io/README.md
0x1eef cee85d98f9 README: update
2024-03-15 15:06:16 -03:00

1.3 KiB
Raw Blame History

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 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.

Development

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

# Install Ruby, NodeJS packages
bundle install
npm i

# Build website
rake build

# Start web server
rake server

Thanks

First and foremost, Alhamdulillah.

  • Thanks to the following graphic artists:

  • Thanks to the following translators:

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

License

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