ReflectsLight/al-quran.reflectslight.io
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Read and listen to The Noble Quran from your browser
1072 commits 1 branch 0 tags 79 MiB
TypeScript 53.8%
Ruby 22.1%
SCSS 10.8%
HTML 9.2%
JavaScript 2.7%
Other 1.4%
Find a file
0x1eef f5509f3f14 nanoc.yaml -> nanoc.yaml.sample 
This change allows changes to be made to
nanoc.yaml that don't have to be checked
back into the repository.

The bin/setup script will copy the sample
file into place.
2024-07-20 21:51:53 -03:00
.bundle Update .bundle/config 2024-02-01 06:41:18 -03:00
.github Require >=Ruby32 2024-06-20 19:03:47 -03:00
bin nanoc.yaml -> nanoc.yaml.sample 2024-07-20 21:51:53 -03:00
nanoc Fix example in API docs 2024-06-22 19:21:16 -03:00
packages Update postman/README.md 2024-05-24 14:45:36 -03:00
rake/tasks Update server.rake 2024-06-22 14:12:50 -03:00
share/al-quran.reflectslight.io/docs Add AddNewLanguage.md 2024-06-21 21:50:19 -03:00
src Apply same margin-top across locales 2024-07-20 15:31:51 -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
.eslintrc.js Update loaders 2024-06-09 15:28:35 -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
Gemfile Update nanoc-tidy.rb 2024-06-15 23:27:24 -03:00
Gemfile.lock Run 'bundle update' 2024-06-22 05:25:52 -03:00
LICENSE License = GPL 2023-03-11 11:42:30 -03:00
nanoc.yaml Update audio.base_url (nanoc.yaml) 2024-06-10 13:09:44 -03:00
nanoc.yaml.sample nanoc.yaml -> nanoc.yaml.sample 2024-07-20 21:51:53 -03:00
package-lock.json Run 'npm update' 2024-06-22 04:55:59 -03:00
package.json Update loaders 2024-06-09 15:28:35 -03:00
Rakefile.rb Fix typos 2024-06-22 00:13:26 -03:00
README.md Require >=Ruby32 2024-06-20 19:03:47 -03:00
Rules Fix default_argv of Nanoc::Tidy 2024-06-22 01:06:21 -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 Add esbuild-loader, upgrade nanoc-webpack.rb 2024-04-25 20:36:34 -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

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.

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 (https://al-quran.reflectslight.io/audio/alafasy) 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:

Thanks

Alhamdulillah

  • Thanks to the graphic artists:

  • 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