Static website for reading / listening to The Noble Quran
Find a file
2023-07-05 15:28:00 -03:00
.github Try to fix GitHub build 2023-03-21 03:36:29 -03:00
config Add localhost to local.yml.sample 2023-03-29 20:19:21 -03:00
lib Remove lib/tasks.rb 2023-03-25 08:58:31 -03:00
packages Add If-None-Match support to Server::ETag 2023-07-05 15:28:00 -03:00
rules Migrate to nanoc-gzip 2023-06-29 19:49:42 -03:00
src Remove another unused local 2023-07-01 19:36:17 -03:00
tasks Add packages/ruby/server/ (#132) 2023-06-25 21:03:07 -03:00
tasks.lib Add packages/ruby/server/ (#132) 2023-06-25 21:03:07 -03:00
.babelrc add TypeScript / React related configuration files 2022-10-31 15:35:43 -03:00
.editorconfig .editorconfig: update 2023-03-17 00:16:43 -03:00
.env.sample Fix GitHub build 2023-03-10 06:13:49 -03:00
.eslintrc.js Add new packet interface (#130) 2023-06-23 21:58:56 -03:00
.gitignore Rename Packet to Postman (#131) 2023-06-23 22:31:25 -03:00
.gitmodules add ruby-related files 2022-10-31 15:36:25 -03:00
.prettierignore eslint & prettier setup 2022-11-11 16:09:33 -03:00
.prettierrc eslint & prettier setup 2022-11-11 16:09:33 -03:00
.projectile Update .projectile 2023-03-10 09:21:54 -03:00
.rubocop.yml Replace Tasks::Deploy::Local 2023-03-25 08:02:55 -03:00
Gemfile Migrate to nanoc-gzip 2023-06-29 19:49:42 -03:00
Gemfile.lock Migrate to nanoc-gzip 2023-06-29 19:49:42 -03:00
LICENSE License = GPL 2023-03-11 11:42:30 -03:00
nanoc.yaml Create logs, and destination directories on deploy 2023-02-14 18:09:41 -03:00
package-lock.json Update package-lock.json 2023-06-30 16:02:25 -03:00
package.json WebPackage -> Packet 2023-06-21 19:58:31 -03:00
Rakefile.rb Update Rakefile.rb 2023-07-04 23:17:18 -03:00
README.md README: update 2023-07-04 23:36:43 -03:00
Rules Migrate to nanoc-gzip 2023-06-29 19:49:42 -03:00
tsconfig.json WebPackage -> Packet 2023-06-21 19:58:31 -03:00
VERSION v0.3.1 2023-03-17 00:18:21 -03:00
webpack.config.js WebPackage -> Packet 2023-06-21 19:58:31 -03:00

About

This repository contains the source code of al-quran.reflectslight.io, a static website for reading The Quran. After the website is built, the build directory consists of HTML, CSS, JavaScript and other static assets that can be hosted by a regular web server (eg nginx, apache, etc).

The stack

  • Ruby 3.1, or later.
  • NodeJS v18.15, or later.
  • TypeScript

Local development

1. Clone

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

2. Install Ruby, and NodeJS packages

bundle install
npm i

3. Build website

rake build

4. Start server on localhost

rake server

Credits

Credit is due to the graphic artists whose art is used by the website, and with thanks I credit the following graphic files to their respective authors:

Credit is due to the people who translated The Quran from Arabic to other languages, and with thanks I credit the following translations to their respective authors:

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