Skip to content
ganjoorPublic
forked from thecurumo/qaf_app

About

A fully offline Persian literature and poetry archive for Android, crafted for an immersive reading experience.

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

16 Commits

Folders and files

Repository files navigation

Qaf | قاف

A fully offline archive of Persian literature for Android

آرشیو کاملاً آفلاین ادبیات پارسی برای اندروید

English  |  فارسی

Version 1.1.0  |  MIT License  |  Built with Capacitor


صفحه نخست و معرفی
خانه / معرفی
فهرست سخنوران
سخنوران
خوانش اثر و اشعار
حالت خوانش
جستجوی پیشرفته
جست‌وجو
گنجینه آثار و دیوان‌ها
آثار و دیوان‌ها
بایگانی و نشان‌ها
نشان‌ها

English

Overview

Qaf is a free, offline-first reading and search application for classical and modern Persian poetry. The complete reference database ships inside the app, so every poet, work, poem and verse is available without an internet connection, with no account and no tracking.

The name refers to the letter Qaf, the mythical mountain of Persian literature.

Features

Browsing

  • Home screen with quick access to poets and works, and a shortcut back to what you were reading.
  • Poets directory with a detail page for each poet, including portraits.
  • Works directory with a hierarchical view that follows the structure of each book (sections, chapters, poems).
  • Poem reader with previous and next navigation and a distraction-free zen reading mode.

Search

  • Global search across poets, works, poems and verses.
  • Every word of a query must match, in any order.
  • Normalization of Persian and Arabic character variants (for example the different forms of ye, kaf and alef), Persian, Arabic and Latin digits, half-spaces, and diacritics, so a search finds the text regardless of how it was typed.
  • Results are ranked: exact matches first, then prefix matches, word-start matches and finally partial matches.
  • Filters by century, poet and city.

Personal library

  • Bookmarks for poets, works, poems and individual verses, organized in one place.
  • Reading history that can be cleared at any time.
  • Copy a single verse or a complete poem to the clipboard.

Experience

  • Light and dark themes, following the system setting by default.
  • Right-to-left interface designed for Persian typography, using the Arad typeface.
  • All user data (bookmarks, history, theme) stays on the device.

Privacy

The application code makes no network requests and includes no analytics or advertising. Reading history and bookmarks are stored locally on the device and never leave it.

Technology

Layer Details
Application Vanilla HTML, CSS and JavaScript (capacitor-app/www/index.html)
Native shell Capacitor 8, Android
Database SQLite through @capacitor-community/sqlite, installed from the bundled asset on first launch
Search SQL GLOB matching with character-class normalization and ranked ordering

Repository structure

qaf_app/
  images/                Screenshots & previews
  capacitor-app/
    www/                 Web application (index.html, fonts, poet images, database asset)
    android/             Native Android project generated by Capacitor
    assets/              Source artwork for the app icon and splash screen
    capacitor.config.json
    package.json
  .github/workflows/     Manual CI workflow that builds a debug APK
  deploy-to-drive.sh     Development helper: build and upload a debug APK with rclone
  LICENSE

The database asset (capacitor-app/www/assets/databases/qaf.db.gz) is stored with Git LFS. Cloning with Git LFS installed is required to obtain it. The "Download ZIP" button on GitHub does not include it.

Installation

Download the latest APK from the Releases page and open it on an Android device. You may need to allow installation from unknown sources for your browser or file manager.

Building from source

Requirements: Git with Git LFS, Node.js 22 or newer, JDK 21, and the Android SDK.

git lfs install
git clone https://github.com/thecurumo/qaf_app.git
cd qaf_app/capacitor-app

npm ci
npx cap sync android

cd android
./gradlew assembleDebug

The APK is written to capacitor-app/android/app/build/outputs/apk/debug/app-debug.apk. To work on the native project in Android Studio, run npx cap open android from capacitor-app.

After changing anything inside www/, run npx cap sync android before rebuilding.

Data sources and credits

The literary database is derived from the open data published and archived by Ganjoor. Qaf would not exist without their decades of work, and it is not affiliated with or endorsed by Ganjoor. The texts remain subject to the terms and attributions defined by Ganjoor and by the original sources it cites.

The poet portraits are original illustrations created by the project author. The Arad typeface is used under the SIL Open Font License 1.1. Qaf also relies on Capacitor and the Capacitor Community SQLite plugin, each distributed under its own license.

Contributing

Bug reports, corrections and suggestions are welcome through GitHub Issues. When reporting a problem, please include your Android version, device model and steps to reproduce it.

Support

Qaf is free and will remain free. Optional ways to support its development are listed on the About page inside the app.

License

The source code of Qaf is released under the MIT License. This license applies to the application code only. The literary data, fonts and other third-party assets are governed by their respective terms, as described above.


فارسی

معرفی

«قاف» یک برنامهٔ رایگان و آفلاین برای خواندن و جست‌وجوی شعر پارسی است. پایگاه داده کامل درون خود برنامه قرار دارد؛ بنابراین تمام سخنوران، آثار، اشعار و ابیات بدون نیاز به اینترنت، بدون حساب کاربری و بدون هیچ‌گونه ردیابی در دسترس هستند.

نام «قاف» یادآور کوه قاف، کوه اسطوره‌ای ادبیات پارسی است.

ویژگی‌ها

مرور

  • صفحهٔ اصلی با دسترسی سریع به سخنوران و آثار، و بازگشت به آخرین متنی که می‌خواندید.
  • فهرست سخنوران با صفحهٔ اختصاصی برای هر سخنور، همراه با تصویر.
  • فهرست آثار با نمایش سلسله‌مراتبی که ساختار هر کتاب (بخش‌ها، فصل‌ها و اشعار) را دنبال می‌کند.
  • خواننده شعر با پیمایش قبلی و بعدی و حالت مطالعهٔ آرام (Zen) برای خواندن بدون حواس‌پرتی.

جست‌وجو

  • جست‌وجوی سراسری در سخنوران، آثار، اشعار و ابیات.
  • تمام واژه‌های عبارت جست‌وجو باید در نتیجه باشند، با هر ترتیبی.
  • یکسان‌سازی شکل‌های فارسی و عربی حروف (مانند انواع «ی»، «ک» و «ا»)، ارقام فارسی، عربی و لاتین، نیم‌فاصله و اعراب؛ بنابراین متن مورد نظر شما صرف‌نظر از شیوهٔ تایپ پیدا می‌شود.
  • رتبه‌بندی نتایج: ابتدا تطابق کامل، سپس آغاز عبارت، آغاز واژه و در پایان تطابق جزئی.
  • فیلتر بر اساس قرن، سخنور و شهر.

کتابخانهٔ شخصی

  • نشان‌کردن سخنوران، آثار، اشعار و ابیات و مدیریت آن‌ها در یک صفحه.
  • تاریخچهٔ خوانش که هر زمان می‌توان آن را پاک کرد.
  • کپی یک بیت یا کل شعر در کلیپ‌بورد.

تجربهٔ کاربری

  • پوستهٔ روشن و تیره، به‌صورت پیش‌فرض مطابق تنظیم سیستم.
  • رابط راست‌به‌چپ، طراحی‌شده برای حروف‌چینی فارسی با فونت آراد.
  • تمام داده‌های کاربر (نشان‌ها، تاریخچه و پوسته) روی دستگاه می‌ماند.

حریم خصوصی

کد برنامه هیچ درخواست شبکه‌ای ارسال نمی‌کند و شامل ابزار تحلیل یا تبلیغات نیست. تاریخچه و نشان‌ها فقط روی دستگاه شما ذخیره می‌شوند و از آن خارج نمی‌شوند.

فناوری

لایه جزئیات
برنامه HTML، CSS و JavaScript خالص (capacitor-app/www/index.html)
پوستهٔ بومی Capacitor نسخه ۸، اندروید
پایگاه داده SQLite از طریق @capacitor-community/sqlite، نصب‌شده از فایل همراه برنامه در اولین اجرا
جست‌وجو تطبیق GLOB در SQL با یکسان‌سازی گروه‌های نویسه و مرتب‌سازی بر اساس رتبه

ساختار مخزن

qaf_app/
  images/                Screenshots & previews
  capacitor-app/
    www/                 Web application (index.html, fonts, poet images, database asset)
    android/             Native Android project generated by Capacitor
    assets/              Source artwork for the app icon and splash screen
    capacitor.config.json
    package.json
  .github/workflows/     Manual CI workflow that builds a debug APK
  deploy-to-drive.sh     Development helper: build and upload a debug APK with rclone
  LICENSE

فایل پایگاه داده (capacitor-app/www/assets/databases/qaf.db.gz) با Git LFS نگهداری می‌شود. برای دریافت آن باید مخزن را با نصب‌بودن Git LFS کلون کنید. دکمهٔ «Download ZIP» در گیت‌هاب این فایل را شامل نمی‌شود.

نصب

آخرین فایل APK را از صفحهٔ Releases دانلود و روی دستگاه اندروید باز کنید. ممکن است لازم باشد نصب از منابع ناشناس را برای مرورگر یا مدیر فایل خود فعال کنید.

ساخت از روی سورس

پیش‌نیازها: Git همراه با Git LFS، نسخهٔ ۲۲ یا بالاتر Node.js، JDK 21 و Android SDK.

git lfs install
git clone https://github.com/thecurumo/qaf_app.git
cd qaf_app/capacitor-app

npm ci
npx cap sync android

cd android
./gradlew assembleDebug

فایل APK در مسیر capacitor-app/android/app/build/outputs/apk/debug/app-debug.apk ساخته می‌شود. برای کار روی پروژهٔ بومی در Android Studio، دستور npx cap open android را داخل پوشهٔ capacitor-app اجرا کنید.

پس از هر تغییر در پوشهٔ www/، پیش از بیلد دوباره دستور npx cap sync android را اجرا کنید.

منبع داده و قدردانی

پایگاه داده ادبی این برنامه بر پایهٔ داده‌های آزاد منتشرشده و آرشیوشده توسط گنجور تهیه شده است. قاف بدون سال‌ها تلاش گنجور ممکن نبود؛ با این حال قاف وابسته به گنجور نیست و از سوی آن تأیید نشده است. متن‌ها همچنان تابع شرایط و ارجاعاتی هستند که گنجور و منابع اصلی آن تعیین کرده‌اند.

تصاویر سخنوران توسط نگارندهٔ پروژه ساخته شده است. فونت آراد با مجوز SIL Open Font License 1.1 استفاده شده است. قاف همچنین از Capacitor و افزونهٔ SQLite جامعهٔ Capacitor استفاده می‌کند که هر یک تابع مجوز خود هستند.

مشارکت

گزارش خطا، اصلاحات و پیشنهادها را از طریق Issues در گیت‌هاب بفرستید. لطفاً در گزارش مشکل، نسخهٔ اندروید، مدل دستگاه و مراحل بازتولید خطا را بنویسید.

حمایت

قاف رایگان است و رایگان خواهد ماند. راه‌های اختیاری حمایت از توسعهٔ آن در صفحهٔ «دربارهٔ قاف» داخل برنامه آمده است.

مجوز

کد منبع قاف تحت مجوز MIT منتشر شده است. این مجوز فقط شامل کد برنامه است. داده‌های ادبی، فونت‌ها و سایر منابع شخص ثالث تابع شرایط مربوط به خود هستند، همان‌طور که در بالا توضیح داده شد.

About

A fully offline Persian literature and poetry archive for Android, crafted for an immersive reading experience.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages