No description
Find a file
2024-11-07 23:31:42 -03:00
.bundle Move towards a Single Page Application (SPA) approach 2024-10-17 21:29:07 -03:00
bin Update bin/setup 2024-10-29 13:36:40 -03:00
etc Redo the audio implementation 2024-11-02 20:19:21 -03:00
nanoc First commit 2024-10-16 23:57:13 -03:00
packages Update packages/typescript/Quran 2024-10-22 22:34:28 -03:00
rake/tasks Add 'rake nanoc:zip' 2024-11-06 17:54:40 -03:00
share/al-quran.reflectslight.io Reset VERSION 2024-11-02 00:42:08 -03:00
src Update icon128x128.png 2024-11-07 23:31:42 -03:00
.editorconfig Fix .editorconfig 2024-11-02 23:23:10 -03:00
.gitignore First commit 2024-10-16 23:57:13 -03:00
.gitmodules Link packages/typescript/Quran/ as a git submodule 2024-10-22 03:56:00 -03:00
Gemfile Run "bundle update" 2024-10-29 13:39:01 -03:00
Gemfile.lock Run "bundle update" 2024-10-29 13:39:01 -03:00
nanoc.yaml.sample Devops (change audio URL) 2024-11-05 12:40:51 -03:00
package-lock.json Reduce typescript errors 2024-10-26 06:11:58 -03:00
package.json Reduce typescript errors 2024-10-26 06:11:58 -03:00
Rakefile.rb First commit 2024-10-16 23:57:13 -03:00
README.md docs: update sources 2024-11-06 18:41:50 -03:00
Rules Re-add <div data-audio-base-url></div> 2024-10-21 22:44:27 -03:00

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:

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