.bundle | ||
bin | ||
etc | ||
nanoc | ||
packages | ||
rake/tasks | ||
share/al-quran.reflectslight.io | ||
src | ||
.editorconfig | ||
.gitignore | ||
.gitmodules | ||
Gemfile | ||
Gemfile.lock | ||
nanoc.yaml.sample | ||
package-lock.json | ||
package.json | ||
Rakefile.rb | ||
README.md | ||
Rules |
About
This repository contains a port of the al-quran.reflectslight.io website as a packaged KaiOS application. The project is still in the early stages of development.
Demo
For a demo please see the demo video. The demo video won't always be based on the most recent version of the app but it should give you a good idea of how the app works
Development
Requirements
The following language runtimes are required to build the website from source:
- Ruby 3.2 (or later)
- NodeJS v18.15 (or later)
Examples
# Clone repository
git clone https://github.com/ReflectsLight/al-quran.KaiOS
cd al-quran.KaiOS
# Setup build environment
bin/setup
# List all tasks
bundle exec rake -T
# Build website (dev build)
bundle exec rake nanoc:build
# Build website (production build)
bundle exec rake nanoc:build[production]
# Start web server
bundle exec rake server
Configuration
audio.base_url
audio.base_url
controls what web server serves audio content.
The default
works out of the box. The URL for an audio file is
resolved by joining audio.base_url
and
/<surahid>/<ayahid>.mp3
. The audio.base_url
option
makes it relatively easy to change the reciter
at build time, before building the application.
The https://al-quran-audio.reflectslight.io endpoint provides the following recitations:
- Mishari bin Rashed Alafasy
https://al-quran-audio.reflectslight.io/alafasy - Ahmad bin Ali Al-Ajmi
https://al-quran-audio.reflectslight.io/alajmi - Sahl Yassin
https://al-quran-audio.reflectslight.io/yassin - Hani ar-Rifai
https://al-quran-audio.reflectslight.io/rifai
Due to their overall size the audio files are the only files not kept in this repository. The audio files are hosted by https://al-quran-audio.reflectslight.io instead.
Install
In the future I hope that the application could be easily available through KaiOS store(s), but for now the application is only available via side-loading the application onto a KaiOS device.
Thanks
الْحَمْدُ لِلَّهِ رَبِّ الْعَالَمِينَ
- Thanks to the graphic artists:
- Thanks to the translators:
- English (The Clear Quran) by Dr. Mustafa Khattab
- Farsi by Hussain Ansarian
- Thanks to the reciters:
- Mishari bin Rashed Alafasy
- Ahmad bin Ali Al-Ajmi
- Sahl Yassin
- Hani ar-Rifai
- Thanks to @farooqkz:
Farooq introduced me to KaiOS development
Sources
License
The "source code" is released under the terms of the GPL
See LICENSE for details