Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
66 lines (47 sloc) 2.71 KB

Qawl

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

Mushaf Source โ€” broken up using a terminal script with convert from imagemagick at a DPI of 150.

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.