al-quran.reflectslight.io/README.md

60 lines
1.4 KiB
Markdown
Raw Normal View History

2023-10-08 00:32:27 +02:00
## About
2023-03-08 17:06:10 +01:00
2024-05-20 04:35:43 +02:00
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 nginx,
apache, etc.
2024-05-02 13:04:35 +02:00
## Environment
2023-03-11 15:42:30 +01:00
2024-05-20 04:35:43 +02:00
The following languages and tools have to be
installed to build the website from source:
2024-05-02 13:04:35 +02:00
* Ruby 3.1 (or later)
* NodeJS v18.15 (or later)
* [tidy-html5](https://github.com/htacg/tidy-html5)
2023-03-13 17:13:58 +01:00
2024-05-20 04:36:41 +02:00
**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.
2024-03-15 18:32:31 +01:00
## Development
2024-03-15 18:32:31 +01:00
# Clone repository
git clone https://github.com/ReflectsLight/al-quran.git
cd al-quran
2024-05-02 13:04:35 +02:00
# Setup build environment
bin/setup
2024-05-25 05:20:39 +02:00
# List all tasks
rake -T
2024-03-15 18:32:31 +01:00
# Build website
2024-03-16 07:56:14 +01:00
rake nanoc:build
2024-03-15 18:32:31 +01:00
# Start web server
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
2024-05-20 04:35:43 +02:00
Alhamdulillah
2023-07-10 04:34:38 +02:00
2024-05-20 01:22:14 +02:00
* Thanks to the graphic artists:
2024-03-15 18:32:31 +01:00
- [RefreshIcon](/src/js/components/Icon.tsx)
by
2024-05-02 13:07:33 +02:00
[Muhammad Haq](https://freeicons.io/profile/823)
2023-07-10 04:34:38 +02:00
2024-05-20 01:22:14 +02:00
* Thanks to the translators:
2024-03-15 18:32:31 +01:00
- English (The Clear Quran) by Dr. Mustafa Khattab
2024-05-20 04:35:43 +02:00
- Farsi by Hussain Ansarian
2024-03-15 18:32:31 +01:00
## License
2024-05-20 04:35:43 +02:00
The "source code" is released under the terms of the GPL <br>
See [./LICENSE](./LICENSE) for details