ReflectsLight/al-quran.reflectslight.io: Read and listen to The Noble Quran from your browser

ReflectsLight/al-quran.reflectslight.io

Read and listen to The Noble Quran from your browser

Find a file

0x1eef 2a46879a68 Run "bundle update"		2024-08-13 17:56:06 -03:00
.bundle	Update .bundle/config	2024-02-01 06:41:18 -03:00
.github	Update github action	2024-07-29 16:17:25 -03:00
bin	nanoc.yaml -> nanoc.yaml.sample	2024-07-20 21:51:53 -03:00
nanoc	Group locals onto 'context'	2024-08-13 16:59:59 -03:00
packages	Add: surah.{urlName,translitName}	2024-08-13 16:36:35 -03:00
rake/tasks	Split ci.rake into multiple tasks	2024-07-29 09:46:33 -03:00
share	Add CHANGELOG	2024-08-12 19:13:42 -03:00
src	Group locals onto 'context'	2024-08-13 16:59:59 -03:00
submodules	Update submodules/surah-name-glyphs	2024-06-21 15:49:44 -03:00
.editorconfig	Update .editorconfig	2024-05-26 16:54:30 -03:00
.gitignore	nanoc.yaml -> nanoc.yaml.sample	2024-07-20 21:51:53 -03:00
.gitmodules	Add Farsi support	2024-05-19 16:51:37 -03:00
.projectile	Add Quran.locales	2024-05-15 21:51:04 -03:00
.rubocop.yml	Run 'bundle update'	2024-06-22 05:25:52 -03:00
eslint.config.mjs	Fix CI	2024-07-29 16:31:19 -03:00
Gemfile	Run "bundle update"	2024-08-13 17:56:06 -03:00
Gemfile.lock	Run "bundle update"	2024-08-13 17:56:06 -03:00
LICENSE	License = GPL	2023-03-11 11:42:30 -03:00
nanoc.yaml.sample	Fix nanoc.yaml.sample	2024-08-08 02:12:57 -03:00
package-lock.json	Update typescript-eslint	2024-07-29 16:28:02 -03:00
package.json	Update typescript-eslint	2024-07-29 16:28:02 -03:00
Rakefile.rb	Fix typos	2024-06-22 00:13:26 -03:00
README.md	Update README	2024-08-12 18:05:04 -03:00
Rules	Group locals onto 'context'	2024-08-13 16:59:59 -03:00
tsconfig.json	Drop 'allowJs' from tsconfig.json	2024-05-02 10:30:45 -03:00
VERSION	v0.8.8	2024-06-22 01:26:22 -03:00
webpack.common.js	Replace ruby sass with nodejs sass	2024-07-22 23:06:52 -03:00
webpack.development.js	Add per-env webpack configuration files	2024-02-18 09:26:04 -03:00
webpack.production.js	Add esbuild-loader, upgrade nanoc-webpack.rb	2024-04-25 20:36:34 -03:00

README.md

About

This repository contains the source code of 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.2 (or later)
NodeJS v18.15 (or later)
tidy-html5

Development

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

# Setup build environment
bin/setup

# List all tasks
rake -T

# Build website (dev build)
rake nanoc:build

# Build website (production build)
rake nanoc:build[production]

# Start web server
rake server

Configuration

server.base_url
If you plan to host the website on your own domain you should update nanoc.yaml first. In certain places links will reference https://al-quran.reflectslight.io instead of using a relative path. For example /src/sitemap.xml.erb is one such place. Those links can be updated to your own domain by changing the server.base_url field in nanoc.yaml before running rake nanoc:build.
audio.base_url
audio.base_url controls what web server serves audio content. The default works out of the box. The URL for an audio file is resolved by joining audio.base_url and /<surahid>/<ayahid>.mp3. The audio.base_url option makes it relatively easy to change the reciter at build time, before deploying the website.

The https://al-quran.reflectslight.io web server provides the following recitations:
- Mishari bin Rashed Alafasy
  https://al-quran.reflectslight.io/audio/alafasy
- Ahmad bin Ali Al-Ajmi
  https://al-quran.reflectslight.io/audio/alajmi
- Sahl Yassin
  https://al-quran.reflectslight.io/audio/yassin
Note
Due to their overall size the audio files are the only files not kept in this repository. The audio files are hosted by https://al-quran.reflectslight.io instead.

Thanks

الْحَمْدُ لِلَّهِ رَبِّ الْعَالَمِينَ

Thanks to the graphic artists:
- RefreshIcon by Muhammad Haq
Thanks to the translators:
- English (The Clear Quran) by Dr. Mustafa Khattab
- Farsi by Hussain Ansarian
Thanks to the reciters:
- Mishari bin Rashed Alafasy
- Ahmad bin Ali Al-Ajmi
- Sahl Yassin

License

The "source code" is released under the terms of the GPL
See LICENSE for details