No description
Find a file
2023-01-03 23:04:37 -03:00
.github actions: add "build" step, add "prepare-env" action. 2022-11-19 18:31:52 -03:00
lib filters/: add nanoc-webpack.rb 2022-11-18 22:27:54 -03:00
src Maintain rtl direction on .surah-row.surah-details 2022-12-30 08:58:43 -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 Gemfile: update. 2022-11-20 04:41:28 -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 Fix dependency tree 2022-12-24 11:19:37 -03:00
nanoc.yaml Fit content on 1368x768 device (follow up) 2022-12-24 13:01:53 -03:00
package-lock.json add "WebPackage" 2022-11-18 17:09:32 -03:00
package.json Add eslint-autofix script 2022-12-24 15:52:14 -03:00
Rakefile.rb Don't exit when "sh" fails 2022-12-28 03:40:49 -03:00
README.md readme: update 2023-01-03 23:04:37 -03:00
Rules Add Select component 2022-12-28 04:01:23 -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 the source code for a static website that can be used to read The Quran.
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

After the dependencies have been installed, the website can be built.
The build will generate the ./build/al-quran directory:

$ ruby -S rake build

Run the website

The website can be run on http://localhost:3000 with the following command:

$ ruby -S rake server

Authors

License

This software is released into the Public Domain.