al-quran.reflectslight.io/README.md

70 lines
1.6 KiB
Markdown
Raw Normal View History

2023-07-05 04:33:56 +02:00
<p align="left">
2023-07-05 04:36:43 +02:00
<strong>About</strong>
2023-03-08 17:06:10 +01:00
</p>
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-07-05 04:32:16 +02:00
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).
2023-03-11 15:42:30 +01:00
2023-07-05 04:33:56 +02:00
<p align="left">
2023-07-05 04:32:16 +02:00
<strong>The stack</strong>
2023-03-11 15:42:30 +01:00
</p>
2023-07-05 04:32:16 +02:00
* Ruby 3.1, or later.
* NodeJS v18.15, or later.
* TypeScript
2023-03-13 17:13:58 +01:00
2023-07-05 04:33:56 +02:00
<p align="left">
2023-07-05 04:32:16 +02:00
<strong>Local development</strong>
</p>
2023-07-05 04:32:16 +02:00
__1. Clone__
git clone https://github.com/ReflectsLight/al-quran.git
cd al-quran
2023-07-05 04:32:16 +02:00
__2. Install Ruby, and 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-07-05 04:33:56 +02:00
<p align="left">
2023-03-13 17:13:58 +01:00
<strong>Credits</strong>
</p>
2023-07-05 04:32:16 +02:00
Credit is due to the graphic artists whose art is used by
the website, and with thanks I credit the following graphic
files to their respective authors:
2023-03-13 17:13:58 +01:00
* [/src/favicon.png](/src/favicon.png)
by
[Aficons](https://freeicons.io/profile/9247).
* [/src/images/moon.svg](/src/images/moon.svg)
by
[Aficons](https://freeicons.io/profile/9247).
* [/src/images/leaf.svg](/src/images/leaf.svg)
by
[Fasil](https://freeicons.io/profile/722).
2023-07-05 04:32:16 +02:00
Credit is due to the people who translated The Quran from
Arabic to other languages, and with thanks I credit the
following translations to their respective authors:
2023-03-13 17:13:58 +01:00
* English (The Clear Quran) by Dr. Mustafa Khattab