مكتبة المكتبات الإسلامية
- ثبّت Docker حسب نظام تشغيلك من خلال هذا الرابط
- ثبّت Mise حسب نظام تشغيلك من خلال هذا الرابط
- ثبّت مكتبة
gpgحسب نظام تشغيلك. على سبيل المثال، نفّذ هذا الأمر إذا كنت تستخدم نظام macOS: - ثبّت مكتبة
libpqحسب نظام تشغيلك. على سبيل المثال، نفّذ هذا الأمر إذا كنت تستخدم نظام macOS: - أضِف مكتبة
libpqإلى متغيرPATHحسب نظام تشغيلك باتباع التعليمات الموضّحة بعد تثبيت المكتبة. على سبيل المثال، نفّذ هذا الأمر إذا كنت تستخدم نظام macOS معZsh:
brew install gnupg
brew install libpq
echo 'export PATH="/opt/homebrew/opt/libpq/bin:$PATH"' >> /Users/{user}/.zshrc
- نفّذ الأمر التالي لنسخ مستودع المشروع إلى حاسبك:
- افتح سطر الأوامر داخل مجلد المشروع ونفّذ الأمر التالي لتثبيت الأدوات المطلوبة للتطوير من خلال
Mise: - نفّذ الأمر التالي لتثبيت اعتماديات المشروع وتشغيل خادم التطوير المحلّي:
- افتح الرابط
http://localhost:3000في متصفحك للوصول إلى الصفحة الرئيسية للمشروع
git clone git@github.com:ieasybooks/aljam3-web-app.git
mise install
mise dev
ستحصل على الأدوات التالية باتباعك للخطوات المذكورة أعلاه:
- Docker
- Mise
- gnupg
- libpq
- Ruby (3.4.4)
- Rails (8.0.2)
- Node.js (24.1.0)
- Yarn (4.9.1)
- PostgreSQL (17.5)
- Meilisearch (1.15.1)
يمكنك الوصول إلى الخدمات من خلال المنافذ التالية:
- PostgreSQL → 5433 (localhost:5433)
- Meilisearch → 7701 (localhost:7701)
وبمجرّد إيقاف تشغيل خادم التطوير المحلّي من خلال الضغط على Cmd+C أو Ctrl+C، ستتوقف خدمات Docker (PostgreSQL و Meilisearch) عن العمل تلقائيًا.
أُعِدّ هذا المشروع ليعمل مع محرر VSCode أو ما يشبهه من المحررات مثل Cursor و Windsurf وغيرهما. بمجرّد فتح المشروع في أحد هذه المحررات سيظهر لك إشعار يسألك "هل تريد تثبيت الإضافات المُوصى بها؟"، وإذا ضغطت على زر Install ستبدأ عملية تثبيت الإضافات الموجودة في ملف .vscode/extensions.json.
الإضافات المُوصى بها:
- Ruby LSP
- Rails DB Schema
- Rails I18n
- Tailwind CSS IntelliSense
- vscode-gemfile
- GitLens — Git supercharged
- Mise VSCode
- Stimulus LSP
- Live Preview
- SQLTools
- SQLTools PostgreSQL/Cockroach Driver
- vscode-icons
- Git Blame
كما أن إعدادات جميع هذه الإضافات موجودة مسبقًا في ملف .vscode/settings.json، لذا لا داعي لإعدادها يدويًّا.
ملاحظة: جميع المكتبات يجب أن تكون مُحددة بإصدار مُعيّن لضمان الاستقرار والتوافق.
- devise
- devise-i18n
- omniauth
- omniauth-google-oauth2
- omniauth-rails_csrf_protection
- rack-attack
- rails_cloudflare_turnstile
- active_record_doctor
- addressable
- annotaterb
- better_errors
- binding_of_caller
- factory_bot_rails
- faker
- hotwire-spark
- i18n-tasks
- net-ssh
- rspec-rails
- rubocop-rake
- rubocop-rspec
- rubocop-rspec_rails
- shoulda-matchers
- simplecov-json
- simplecov
- tqdm
- webmock
- avo
- browser
- cloudflare-rails
- get_process_mem
- memory_profiler
- mission_control-jobs
- pg_query
- pghero
- rack-mini-profiler
- rails_performance
- solid_errors
- stackprof
- strict_ivars
- sys-cpu
- sys-filesystem
بالإضافة إلى مكتبات إطار عمل Ruby on Rails الأساسية.
ملاحظة: جميع المكتبات يجب أن تكون مُحددة بإصدار مُعيّن لضمان الاستقرار والتوافق.
- @floating-ui/dom
- @rails/request.js
- @stimulus-components/clipboard
- @stimulus-components/read-more
- @tailwindcss/forms
- @tailwindcss/typography
- embla-carousel
- prettier
- tom-select
- tw-animate-css
بالإضافة إلى مكتبات إطار عمل Ruby on Rails الأساسية.
ملاحظة: نسعى في هذا المشروع إلى المحافظة على تغطية كاملة (100%) للشيفرة المصدرية بحالات اختبار دقيقة ومفيدة.
- شغّل خادم التطوير من خلال تنفيذ الأمر
mise devأو ابدأ تشغيل خدمات Docker الخاصة بالمشروع من خلال تنفيذ الأمرmise docker:start - نفّذ الأمر
CI=1 bundle exec rspecلتشغيل حالات الاختبار - ستحصل على تقرير بنسبة تغطية الشيفرة المصدرية بحالات الاختبار ويمكنك تصفّح التقرير المُفصّل الموجود في
coverage/index.html - أوقف تشغيل خادم التطوير أو أوقف خدمات Docker إذا كنت شغّلتها من خلال تنفيذ الأمر
mise docker:stop
يمكنك إضافة كتب حقيقية إلى المشروع من إحدى المكتبات المُعالجة رقميًا التالية:
- اختر إحدى المكتبات واستعرض الكتب المتاحة
- احصل على روابط تحميل ملفات PDF و TXT و DOCX للكتاب المطلوب من مستودع المكتبة على HuggingFace
- نفّذ الأمر التالي مع استبدال المتغيرات بالقيم المناسبة:
rake db:import_book -- \ --title="القول الصواب في حكم النسخ في الكتاب" \ --author="ـ" \ --category="علوم القرآن" \ --pages=16 \ --volumes=-1 \ --library-id=1 \ --pdf-urls="https://huggingface.co/datasets/ieasybooks-org/prophet-mosque-library/resolve/main/pdf/1%D9%80%20211.0%20%D8%B9%D9%84%D9%88%D9%85%20%D8%A7%D9%84%D9%82%D8%B1%D8%A2%D9%86/00016%D9%80%20%D8%A7%D9%84%D9%82%D9%88%D9%84%20%D8%A7%D9%84%D8%B5%D9%88%D8%A7%D8%A8%20%D9%81%D9%8A%20%D8%AD%D9%83%D9%85%20%D8%A7%D9%84%D9%86%D8%B3%D8%AE%20%D9%81%D9%8A%20%D8%A7%D9%84%D9%83%D8%AA%D8%A7%D8%A8%20---%20%D9%80.PDF/KTB.pdf" \ --txt-urls="https://huggingface.co/datasets/ieasybooks-org/prophet-mosque-library/resolve/main/txt/1%D9%80%20211.0%20%D8%B9%D9%84%D9%88%D9%85%20%D8%A7%D9%84%D9%82%D8%B1%D8%A2%D9%86/00016%D9%80%20%D8%A7%D9%84%D9%82%D9%88%D9%84%20%D8%A7%D9%84%D8%B5%D9%88%D8%A7%D8%A8%20%D9%81%D9%8A%20%D8%AD%D9%83%D9%85%20%D8%A7%D9%84%D9%86%D8%B3%D8%AE%20%D9%81%D9%8A%20%D8%A7%D9%84%D9%83%D8%AA%D8%A7%D8%A8%20---%20%D9%80.PDF/KTB.txt" \ --docx-urls="https://huggingface.co/datasets/ieasybooks-org/prophet-mosque-library/resolve/main/docx/1%D9%80%20211.0%20%D8%B9%D9%84%D9%88%D9%85%20%D8%A7%D9%84%D9%82%D8%B1%D8%A2%D9%86/00016%D9%80%20%D8%A7%D9%84%D9%82%D9%88%D9%84%20%D8%A7%D9%84%D8%B5%D9%88%D8%A7%D8%A8%20%D9%81%D9%8A%20%D8%AD%D9%83%D9%85%20%D8%A7%D9%84%D9%86%D8%B3%D8%AE%20%D9%81%D9%8A%20%D8%A7%D9%84%D9%83%D8%AA%D8%A7%D8%A8%20---%20%D9%80.PDF/KTB.docx"
ملاحظة: هذه الخطوات مخصصة لإضافة المكتبات الكاملة إلى الجامع بعد نشره، وليس في بيئة التطوير.
-
حمّل ملف
index.tsvالخاص بالمكتبة المطلوبة من مستودعها على HuggingFace. على سبيل المثال، يمكنك تحميل ملف فهرس المكتبة الوقفية من هذا الرابط. - نفّذ الأمر التالي مع تعديل المتغيرات حسب المكتبة المطلوبة:
ruby script/import_books.rb \ --index-path=path/to/index.tsv \ --huggingface-library-id=ieasybooks-org/library-dataset-id \ --aljam3-library-id=0 \ --server-ip=$SERVER_IP \ --server-username=$SERVER_USERNAME
على سبيل المثال، الأمر التالي يُضيف المكتبة الوقفية إلى الجامع
ruby script/import_books.rb \ --index-path=/path/to/index.tsv \ --huggingface-library-id=ieasybooks-org/waqfeya-library \ --aljam3-library-id=2 \ --server-ip=$SERVER_IP \ --server-username=$SERVER_USERNAME