0x1eef/al-quran.reflectslight.io
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
Static website for reading / listening to The Noble Quran
361 commits 2 branches 65 tags 91 MiB
TypeScript 54.6%
Ruby 21.5%
SCSS 10.7%
HTML 9.1%
JavaScript 2.7%
Other 1.4%
Find a file
Robert 7cc2c7f73a
Merge pull request #141 from ReflectsLight/add_spinner 
Add spinner
2023-07-17 09:23:39 -03:00
.github Add prettier GitHub action 2023-07-13 14:11:07 -03:00
.husky installed husky 2023-07-16 07:27:56 +00:00
config Add localhost to local.yml.sample 2023-03-29 20:19:21 -03:00
lib rubocop -A 2023-07-12 13:34:12 -03:00
nanoc/rules Move "rules/" to "nanoc/rules/". 2023-07-17 07:19:43 -03:00
packages server: fix cache bust 2023-07-09 02:16:55 -03:00
src Add spinner 2023-07-17 09:16:22 -03:00
tasks Fix deploy task 2023-07-12 21:31:54 -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 Disable conflicting eslint rules 2023-07-13 14:11:07 -03:00
.gitignore Update .gitignore 2023-07-12 14:54:11 -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 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 don't install husky in CI context 2023-07-16 07:37:08 +00:00
package.json don't install husky in CI context 2023-07-16 07:37:08 +00:00
Rakefile.rb Fix deploy task 2023-07-12 21:31:54 -03:00
README.md Add audio support 2023-07-12 17:20:32 -03:00
Rules Move "rules/" to "nanoc/rules/". 2023-07-17 07:19:43 -03:00
tsconfig.json WebPackage -> Packet 2023-06-21 19:58:31 -03:00
VERSION v0.4.5 2023-07-15 06:01:14 -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.