Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
67 lines (49 sloc) 2.75 KB

This repo is under maintenance, no future development. Follow the re-write at the new repo: https://github.com/mr-islam/qawl-svelte

logo

Why Qawl?

There are dozens of amazing Qur'膩n applications on mobile devices, and some great ones online for all devices (like the awesome quran.com) 鈥 but there was nothing up-to-date that targeted desktop computers/laptops with only useful features (without excess) and beautiful design.

Qawl is an uncompromising desktop Qur'膩n reading app, featuring:

  • Lightning-fast startup and performance
  • Ultra high-quality scanned mushaf 馃摲
  • Beautiful-yet-effective design 馃敭
  • Powerful navigation using table of contents, page flip, or direct entry 馃幆
  • Precise, user-controlled zoom 馃攷
  • One-click access to recitations, tafsir and translations 馃柋
  • Offline support
  • Comprehensive keyboard shortcuts 馃幑
  • Stunning dark theme 馃寵
  • Resume directly at your last read page, zoom and theme 馃捑
  • Natural controls with simple click-and-drag scrolling, touchpad pinch gestures, and automatic entry of page when pressing number keys 鉁嬸煆
  • Helpful tooltips to explain all features and teach keyboard shortcuts 馃挱

See Qawl in action.

Installation

Head to the releases page and choose the appropriate download for your operating system.

Keyboard Shortcuts

Tooltips within the app also explain the keyboard shortcuts for the respective function

Action Shortcut
Turn page left A
Turn page right D
Next Surah W
Previous Surah S
Zoom in =
Zoom out -
Toggle fullscreen F11
Toggle theme T
Jump to last page E
Open on quran.com Q

Development

  1. Clone the repo
  2. cd to the directory
  3. Run npm i to install (dev) dependencies
  4. npm start to run the app locally
  5. Build using npm run dist

New Mushaf Source: From the King Fahd Glorious Quran Printing Complex online site.

Structure: package.json calls main.js, which loads index.html, which then loads script.js/surahs.js/style.css.

Design Decisions:

  • Mobile devices will not be supported; there are already amazing native apps built for them. Qawl supports tablet screen-sizes, though.
  • This is meant to replicate the mushaf, so single-page view won't be supported.
  • Notes & bookmarks will not be added to the app; keeping separate (digital/manual) notebooks is encouraged instead.