No description
Find a file
2024-05-19 17:37:13 -03:00
.bundle Update .bundle/config 2024-02-01 06:41:18 -03:00
.github Update .github/ 2024-05-17 02:58:19 -03:00
bin Depend on rubygems.org for server.rb 2024-05-02 08:27:11 -03:00
documentation Add Farsi support 2024-05-19 16:51:37 -03:00
nanoc Add opengraph to root path 2024-05-16 17:02:35 -03:00
packages Add Farsi support 2024-05-19 16:51:37 -03:00
rake/tasks Remove submodules.rake 2024-05-02 10:48:29 -03:00
src Update Filter.tsx 2024-05-19 17:30:04 -03:00
submodules Add Farsi support 2024-05-19 16:51:37 -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 Populate surah via info.json 2024-05-14 23:09:31 -03:00
.gitmodules Add Farsi support 2024-05-19 16:51:37 -03:00
.prettierignore eslint & prettier setup 2022-11-11 16:09:33 -03:00
.prettierrc 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 rubocop: add linter.rake 2023-07-25 14:19:00 -03:00
Gemfile Remove unused dependencies 2024-05-02 08:34:35 -03:00
Gemfile.lock Remove unused dependencies 2024-05-02 08:34:35 -03:00
LICENSE License = GPL 2023-03-11 11:42:30 -03:00
nanoc.yaml Add nanoc/ruledsl/filter.rb 2024-05-02 10:08:15 -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 Recover when deploy.rake doesn't exist 2024-05-17 03:02:13 -03:00
README.md README: trim trailing whitespace 2024-05-02 08:17:25 -03:00
Rules Add Farsi support 2024-05-19 16:51:37 -03:00
tsconfig.json Drop 'allowJs' from tsconfig.json 2024-05-02 10:30:45 -03:00
VERSION v0.8.0 2024-05-19 17:37:13 -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.