al-quran.reflectslight.io/README.md

## About

This repository contains the source code of
[al-quran.reflectslight.io](https://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, etc.

## Requirements

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](https://github.com/htacg/tidy-html5)

**Please note** that the audio files are hosted by
https://al-quran.reflectslight.io, and due to
their overall size they are only files **not**
kept in this repository.

## Development

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

    # Setup build environment
    bin/setup

    # List all tasks
    rake -T

    # Build website
    rake nanoc:build

    # Start web server
    rake server

## Configuration

If you plan to host the website on your own domain
you will probably want to update
[nanoc.yaml](nanoc.yaml)
first. Largely for SEO reasons certain links will
reference the hostname al-quran.reflectslight.io.
Those links can be updated to your own domain by
changing the `server.hostname` field in
[nanoc.yaml](nanoc.yaml).

## Thanks

Alhamdulillah

* Thanks to the graphic artists:
    - [RefreshIcon](/src/js/components/Icon.tsx)
      by
      [Muhammad Haq](https://freeicons.io/profile/823)

* Thanks to the translators:
    - English (The Clear Quran) by Dr. Mustafa Khattab
    - Farsi by Hussain Ansarian

## License

The "source code" is released under the terms of the GPL <br>
See [LICENSE](./LICENSE) for details