Skip to content

ReflectsLight/EasyQuran

Repository files navigation

الْحَمْدُ لِلَّهِ رَبِّ الْعَالَمِينَ

About

EasyQuran is a port of the al-quran.reflectslight.io website as a native KaiOS application. The project is still in the early stages of development. 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/EasyQuran
cd EasyQuran

# 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

The EasyQuran application is available on the bananahacker's store. Alternatively, the application can be side-loaded after cloning the repository and building from source.

Credit

Translations

  • English (The Clear Quran) by Dr. Mustafa Khattab
  • Farsi by Hussain Ansarian

Recitations

  • Mishari bin Rashed Alafasy
  • Ahmad bin Ali Al-Ajmi
  • Sahl Yassin
  • Hani ar-Rifai

Misc

Sources

License

The "source code" is released under the terms of the GPL
See LICENSE for details