al-quran_kaios/README.md

3.1 KiB

About

This repository contains a port of the al-quran.reflectslight.io website for the mobile operating system KaiOS. The project is still in the early stages of development.

Requirements

The following languages have to be installed to build the website from source:

  • Ruby 3.2 (or later)
  • NodeJS v18.15 (or later)

Development

# Clone repository
git clone https://github.com/ReflectsLight/al-quran.reflectslight.io
cd al-quran.reflectslight.io

# 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

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, and the reciter Hani ar-Rifai

License

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