al-quran.reflectslight.io/README.md

78 lines
2.3 KiB
Markdown
Raw Normal View History

2023-03-08 17:06:10 +01:00
<p align="center">
2023-03-11 15:42:30 +01:00
<a href="https://al-quran.reflectslight.io">
https://al-quran.reflectslight.io
</a>
2023-03-08 17:06:10 +01:00
</p>
2023-03-25 12:23:20 +01:00
This git repository contains the source code of a statically compiled
website for reading The Quran. After the website is compiled, it consists
of HTML, CSS, JavaScript and other static assets that can be hosted on a
regular web server. The repository is optimized for nginx, and (Free|Open)BSD
as a deployment target. The source code is a mixture of Ruby, TypeScript, and
2023-03-25 14:17:36 +01:00
JavaScript with React being the driving force on the frontend.
2023-03-11 15:42:30 +01:00
<p align="center">
2023-03-11 15:46:29 +01:00
<strong>Open Source</strong>
2023-03-11 15:42:30 +01:00
</p>
2023-03-25 12:23:20 +01:00
The source code is released under the terms of the GNU Public License (GPL).
No restrictions are placed on the right to modify, copy, redistribute or host
the website on a web server / domain of your own as long as it is done in
accordance with the GPL. See
2023-03-11 15:42:30 +01:00
[LICENSE](./LICENSE)
for a copy of the license, and see
[TLDRLegal](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3)
for a short summary of the GPL.
2023-03-13 17:13:58 +01:00
<p align="center">
<strong>Local install</strong>
</p>
__1) Clone repository__
git clone https://github.com/ReflectsLight/al-quran.git
cd al-quran
__2) Run dependency check__
The `bin/run-dependency-check` script will check that the required
dependencies are available: Ruby, NodeJS, nginx, et cetera.
$ ./bin/run-dependency-check
Assuming it was a success:
found: ruby
found: bundle
found: node
found: npm
found: nginx
found: doas
Otherwise, the dependencies that are missing will be listed. All
dependencies should be found before proceeding to the next step.
2023-03-13 17:13:58 +01:00
<p align="center">
<strong>Credits</strong>
</p>
2023-03-25 12:23:44 +01:00
Credit is due to a number of graphic artists whose work is used by
2023-03-13 17:13:58 +01:00
this project, and with thanks I credit the following graphic files to their
respective authors:
* [/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).
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:
* English (The Clear Quran) by Dr. Mustafa Khattab