Read and listen to The Noble Quran from your browser
Find a file
2024-05-02 08:27:11 -03:00
.bundle Update .bundle/config 2024-02-01 06:41:18 -03:00
.github Add Nanoc::Filters::Tidy 2023-10-07 19:29:52 -03:00
bin Depend on rubygems.org for server.rb 2024-05-02 08:27:11 -03:00
nanoc images/opengraph/ -> images/og/ 2024-05-02 07:32:11 -03:00
packages Depend on rubygems.org for server.rb 2024-05-02 08:27:11 -03:00
rake/tasks Remove rake 2024-03-16 03:53:11 -03:00
src Remove unused src/json/durations/ 2024-05-02 07:52:10 -03:00
submodules Update submodules 2024-04-29 12:03:27 -03:00
.editorconfig .editorconfig: update 2023-03-17 00:16:43 -03:00
.eslintrc.js Fix eslint 2024-04-30 01:05:48 -03:00
.gitignore Add packages/typescript/Quran/ 2024-04-30 09:43:30 -03:00
.gitmodules Depend on rubygems.org for server.rb 2024-05-02 08:27:11 -03:00
.prettierignore eslint & prettier setup 2022-11-11 16:09:33 -03:00
.prettierrc Abide by 80col limit 2023-10-28 12:14:40 -03:00
.projectile Ignore /.gems/ 2024-02-25 11:49:12 -03:00
.rubocop.yml rubocop: add linter.rake 2023-07-25 14:19:00 -03:00
Gemfile Depend on rubygems.org for server.rb 2024-05-02 08:27:11 -03:00
Gemfile.lock Depend on rubygems.org for server.rb 2024-05-02 08:27:11 -03:00
LICENSE License = GPL 2023-03-11 11:42:30 -03:00
nanoc.yaml Add ability to bind to a unix socket. 2024-03-22 10:47:45 -03:00
package-lock.json Add packages/typescript/Quran/ 2024-04-30 09:43:30 -03:00
package.json Add esbuild-loader, upgrade nanoc-webpack.rb 2024-04-25 20:36:34 -03:00
Rakefile.rb Fix server.rb support 2024-03-23 14:46:38 -03:00
README.md README: trim trailing whitespace 2024-05-02 08:17:25 -03:00
Rules Add static JSON to .js files rather than .html files 2024-04-30 22:46:48 -03:00
tsconfig.json Enable 'strictNullChecks' 2024-05-01 12:35:56 -03:00
VERSION v0.7.21 2024-05-02 07:35:52 -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

About

al-quran.reflectslight.io is 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.

Environment

The following languages and tools have to be installed to build the website from source:

  • Ruby 3.1 (or later)
  • NodeJS v18.15 (or later)
  • tidy-html5

Development

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

# Setup build environment
bin/setup

# Build website
rake nanoc:build

# Start web server
rake server

Thanks

Alhamdulillah.

  • Thanks to the following graphic artists:

  • Thanks to the following translators:

    • English (The Clear Quran) by Dr. Mustafa Khattab

License

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