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
1123 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 3675b3b441 v0.9.0
2024-08-22 13:28:04 -03:00
.bundle Update .bundle/config 2024-02-01 06:41:18 -03:00
.github Fix CI 2024-08-20 19:20:41 -03:00
bin Fix misaligned indentation in bin/setup 2024-08-20 23:01:41 -03:00
nanoc v0.9.0 2024-08-22 13:28:04 -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/al-quran.reflectslight.io v0.9.0 2024-08-22 13:28:04 -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 Add "rake" to Gemfile 2024-08-16 18:04:18 -03:00
Gemfile.lock Add "rake" to Gemfile 2024-08-16 18:04:18 -03:00
LICENSE License = GPL 2023-03-11 11:42:30 -03:00
nanoc.yaml.sample Change default recitation 2024-08-22 10:03:53 -03:00
package-lock.json Update package-lock.json 2024-08-16 18:04:18 -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 Thanks to Hani ar-Rifai 2024-08-22 10:24:41 -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
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, et cetera.

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
bundle exec rake -T

# Build website (dev build)
bundle exec rake nanoc:build

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

# Start web server
bundle exec rake server

Configuration

Thanks

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

  • 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
    • Hani ar-Rifai

License

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