ReflectsLight/al-quran.reflectslight.io
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
404 commits 1 branch 0 tags 79 MiB
TypeScript 53.8%
Ruby 22.1%
SCSS 10.8%
HTML 9.2%
JavaScript 2.7%
Other 1.4%
Find a file
0x1eef 88630bae1b 'erb' is relative to the html directory
2023-10-07 19:29:52 -03:00
.bundle Add opengraph 2023-10-05 02:36:47 -03:00
.github Fix Github action (take two) 2023-07-25 14:25:26 -03:00
.husky Update .husky/pre-commit 2023-07-25 14:20:44 -03:00
nanoc 'erb' is relative to the html directory 2023-10-07 19:29:52 -03:00
packages server: fix cache bust 2023-07-09 02:16:55 -03:00
src Add / to end of links on the surah index 2023-10-06 00:06:25 -03:00
tasks Add tasks/nanoc.rake 2023-07-25 15:32:57 -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 Disable conflicting eslint rules 2023-07-13 14:11:07 -03:00
.gitignore Update .gitignore 2023-10-05 02:43:04 -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 prettier: maxwidth = 90 2023-07-13 14:14:22 -03:00
.projectile Update .projectile 2023-03-10 09:21:54 -03:00
.rubocop.yml rubocop: add linter.rake 2023-07-25 14:19:00 -03:00
Gemfile Migrate to nanoc-gzip 2023-06-29 19:49:42 -03:00
Gemfile.lock Add opengraph 2023-10-05 02:36:47 -03:00
LICENSE License = GPL 2023-03-11 11:42:30 -03:00
nanoc.yaml Move "lib/" to "nanoc/lib/" 2023-07-21 13:26:26 -03:00
package-lock.json package: npm audit fix 2023-07-23 14:10:29 -03:00
package.json package: npm audit fix 2023-07-23 14:10:29 -03:00
Rakefile.rb Fix "rake server" 2023-07-27 11:34:15 -03:00
README.md Add audio support 2023-07-12 17:20:32 -03:00
Rules Remove redirect from /en/1/ to /en/al-fatihah/ 2023-10-06 00:06:25 -03:00
tsconfig.json WebPackage -> Packet 2023-06-21 19:58:31 -03:00
VERSION v0.5.4 2023-07-25 14:39:38 -03:00
webpack.config.js WebPackage -> Packet 2023-06-21 19:58:31 -03:00

README.md

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

# Build once
rake build

# Build whenever a change is detected
rake build:watch

4. Start server on localhost

rake server

Thanks

First and foremost, Alhamdulillah.