Static website for reading / listening to The Noble Quran
Find a file
0x1eef 816ea05288 filters/: add nanoc-webpack.rb
Replace lib/filters/webpack.rb with
[nanoc-webpack.rb](https://github.com/0x1eef/nanoc-webpack.rb)
2022-11-18 22:27:54 -03:00
.github/workflows add github linter actions (Ruby / TypeScript) 2022-11-02 00:53:00 -03:00
lib filters/: add nanoc-webpack.rb 2022-11-18 22:27:54 -03:00
src add "WebPackage" 2022-11-18 17:09:32 -03:00
.babelrc add TypeScript / React related configuration files 2022-10-31 15:35:43 -03:00
.env.sample deploy: minify JS assets on production 2022-11-10 19:03:51 -03:00
.eslintrc.js add "WebPackage" 2022-11-18 17:09:32 -03:00
.gitignore eslint & prettier setup 2022-11-11 16:09:33 -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
.rubocop.yml filters/webpack: remove "exe" option. 2022-11-18 00:41:28 -03:00
Gemfile filters/: add nanoc-webpack.rb 2022-11-18 22:27:54 -03:00
Gemfile.lock filters/: add nanoc-webpack.rb 2022-11-18 22:27:54 -03:00
nanoc.yaml Rules: compress surah.json for surahs greater than 10KB in size 2022-11-12 15:28:20 -03:00
package-lock.json add "WebPackage" 2022-11-18 17:09:32 -03:00
package.json add "WebPackage" 2022-11-18 17:09:32 -03:00
Rakefile.rb deploy: minify JS assets on production 2022-11-10 19:03:51 -03:00
README.md add README.md 2022-11-03 19:13:11 -03:00
Rules filters/: add nanoc-webpack.rb 2022-11-18 22:27:54 -03:00
tsconfig.json disable strict null checks (for now) 2022-11-02 06:23:24 -03:00
webpack.config.js deploy: minify JS assets on production 2022-11-10 19:03:51 -03:00

About

This repository contains a statically compiled website for reading The Qur'an.
The website can be seen live at https://al-quran.reflectslight.io.

Build the website

The main components of the website's stack are:

  • Ruby v3.1.2+
  • NodeJS v16.16.0+
  • TypeScript
  • React

Both Ruby, and NodeJS are left to the reader to install.
After installing Ruby, and NodeJS the website's dependencies can be installed:

$ ruby -S gem install bundler --no-document
$ ruby -S bundle install
$ npm i

The website can then be built by running:

$ ruby -S rake build

The above command will generate the static website in ./build/al-quran.

View the website

The website can be viewed on localhost by running:

$ ruby -S rake server

The above command will call rake build, and afterwards start a web server running on http://localhost:3000.

License

This software is released into the Public Domain.