| .github | ||
| bin | ||
| config | ||
| lib | ||
| packages | ||
| rules | ||
| src | ||
| tasks | ||
| tasks.lib | ||
| .babelrc | ||
| .editorconfig | ||
| .env.sample | ||
| .eslintrc.js | ||
| .gitignore | ||
| .gitmodules | ||
| .prettierignore | ||
| .prettierrc | ||
| .projectile | ||
| .rubocop.yml | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| nanoc.yaml | ||
| package-lock.json | ||
| package.json | ||
| Rakefile.rb | ||
| README.md | ||
| Rules | ||
| tsconfig.json | ||
| VERSION | ||
| webpack.config.js | ||
https://al-quran.reflectslight.io
This git repository contains the source code of a statically compiled website for reading The Quran. After the website is compiled, it consists of HTML, CSS, JavaScript and other static assets that can be hosted on a regular web server. The repository is optimized for nginx, and (Free|Open)BSD as a deployment target. The source code is a mixture of Ruby, TypeScript, and JavaScript with React being the driving force on the frontend.
Open Source
The source code is released under the terms of the GNU Public License (GPL). No restrictions are placed on the right to modify, copy, redistribute or host the website on a web server / domain of your own as long as it is done in accordance with the GPL. See LICENSE for a copy of the license, and see TLDRLegal for a short summary of the GPL.
Local install
1. Clone repository
git clone https://github.com/ReflectsLight/al-quran.git
cd al-quran
2. Check dependencies
The bin/check-dependencies script will check that the required
dependencies are available: Ruby, NodeJS, nginx, et cetera.
$ ./bin/check-dependencies
Assuming it was a success:
found: ruby
found: bundle
found: node
found: npm
found: nginx
found: doas
Otherwise, the dependencies that are missing will be listed. All dependencies should be found before proceeding to the next step.
3. Install packages
At this step we're ready to install Ruby, and NodeJS packages:
$ npm install
$ bundle install --path=.bundle/
Credits
Credit is due to a number of graphic artists whose work is used by this project, 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