al-quran.reflectslight.io/README.md

56 lines
1.3 KiB
Markdown
Raw Normal View History

2023-10-08 00:32:27 +02:00
## About
2023-03-08 17:06:10 +01:00
2023-07-05 04:32:16 +02:00
This repository contains the source code of
2023-07-09 05:41:20 +02:00
[al-quran.reflectslight.io](https://al-quran.reflectslight.io),
2023-10-24 04:00:32 +02:00
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).
2023-03-11 15:42:30 +01:00
2023-10-08 00:32:27 +02:00
## Stack
2023-03-11 15:42:30 +01:00
The following languages and tools have to be installed before
the website can be built:
2023-07-05 04:32:16 +02:00
* Ruby 3.1, or later.
* NodeJS v18.15, or later.
* [tidy-html5](https://github.com/htacg/tidy-html5) <br>
There is a good chance there's a package available for
tidy-html5 on your operating system of choice.
2023-03-13 17:13:58 +01:00
2023-10-08 00:32:27 +02:00
## Local development
2023-07-05 04:32:16 +02:00
__1. Clone__
git clone https://github.com/ReflectsLight/al-quran.git
cd al-quran
__2. Install Ruby, NodeJS packages__
2023-07-05 04:32:16 +02:00
bundle install
npm i
2023-07-05 04:32:16 +02:00
__3. Build website__
2023-07-09 03:30:39 +02:00
# Build once
2023-07-05 04:32:16 +02:00
rake build
2023-07-09 03:30:39 +02:00
# Build whenever a change is detected
rake build:watch
2023-07-05 04:32:16 +02:00
__4. Start server on localhost__
2023-07-05 04:32:16 +02:00
rake server
2023-10-08 00:32:27 +02:00
## Thanks
2023-03-13 17:13:58 +01:00
2023-07-10 04:34:38 +02:00
First and foremost, Alhamdulillah.
* Thanks to the following graphic artists:
2023-10-24 03:56:52 +02:00
* [RefreshIcon](/src/js/components/Icon.tsx)
2023-03-27 17:24:46 +02:00
by
[Muhammad Haq](https://freeicons.io/profile/823).
2023-07-10 04:34:38 +02:00
* Thanks to the following translators:
* English (The Clear Quran) by Dr. Mustafa Khattab