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 a07a784f7a Add bin/setup
2024-05-02 08:04:35 -03:00

1.2 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 standard web server (eg nginx, apache, ...).

Environment

The following languages and tools have to be installed to build the website from source:

  • Ruby 3.1 (or later)
  • NodeJS v18.15 (or later)
  • tidy-html5

Development

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

# Setup build environment
bin/setup

# Build website
rake nanoc:build

# Start web server
rake server

Thanks

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.