תוכן עניינים
- אודות הפרויקט
- תחילת העבודה
- מפת דרכים
- תרומה לפרויקט
- רישיון
- יצירת קשר
- תודות
אודות הפרויקט
הרגשתי בחסרונה של אפליקציה בקוד פתוח לספרייה היהודית, עבור מחשבים.
תורת אמת היא ישנה ואינה מתוחזקת עוד, והאפליקציה של ספריא נהדרת, אך היא אינה עובדת היטב על מחשבים.
לכן החלטתי לבנות אחת בעצמי. בהתחלה לא הכרתי כלל את Dart ו-Flutter, אבל זה היה כיף. אני אוהב ללמוד טכנולוגיות חדשות!
מסד הנתונים עצמו נגיש לכולם בעקבות עבודתם החשובה של ארגון ספריא, אז תודה גדולה להם על כך.
תכונות עיקריות של הפרויקט:
- התוכנה היא חינמית ותישאר חינמית לעד.
- נבנתה לעבוד ביעילות על כל מכשיר, כולל Windows, Linux ו-Android.
- האפליקציה תוכננה להיות ידידותית למשתמש ככל האפשר.
- נעשה תהליך בחירה קפדני כדי להבטיח שהספרים מתאימים לציבור התורני.
- הספרייה גמישה, כלומר ניתן להוסיף או להסיר ספרים מהספרייה.
- מנוע חיפוש מהיר, כולל ספרים שהמשתמש הוסיף.
- האפליקציה תומכת בפורמטים הבאים: TXT, Docx ו-PDF.
אני מקווה שעבודתי תסייע לציבור התורני ללמוד בקלות וביעילות בכל זמן ובכל מקום.
(⇧)
נבנה באמצעות
בחרתי להשתמש ב-Dart וב-Flutter. אני חושב שזו הדרך היעילה והמודרנית ביותר לבנות אפליקציה עם ממשק גרפי.
בנוסף, זוהי מסגרת רב-פלטפורמית.
(⇧)
תחילת העבודה
Windows
התקנה
בחרו את קובץ ההתקנה שלכם:
-
התקנה מלאה (מומלץ) - otzaria-x.x.x-windows-full.exe
- כולל את כל התלויות הנדרשות (Visual C++ Redistributable)
- מתקין אוטומטית רכיבים חסרים
- הבחירה הטובה ביותר לרוב המשתמשים
- גודל הורדה גדול יותר (כ-100MB יותר)
-
התקנה רגילה - otzaria-x.x.x-windows.exe
- גודל הורדה קטן יותר
- דורש ש-Visual C++ Redistributable יהיה מותקן מראש
- עבור משתמשים שיודעים שכבר יש להם את התלויות הנדרשות
הורידו את הגרסה האחרונה ל-Windows מ-releases.
הערה: הספרייה כלולה בקובץ ה-.exe.
במקרה שאתם זקוקים רק לאפליקציה עצמה לצורך שדרוג, הורידו את גרסת ה-ZIP ל-Windows מ-releases.
דרישות מקדימות (להתקנה הרגילה בלבד)
אם אתם משתמשים בהתקנה הרגילה, ודאו ש-Visual C++ Redistributable מותקן במחשב שלכם. אם לא, הורידו אותו מ-כאן והתקינו אותו.
Linux
דרישות מקדימות
sudo apt-get install libgtk-3-0 libblkid1 liblzma5
התקנה
- הורידו את גרסת Linux מ-releases, חלצו והריצו את Otzaria.
- עבור גרסאות רשמיות קיים גם חבילה מלאה (FULL):
otzaria-linux-full.tar.zst.
- החבילה המלאה כוללת את האפליקציה והספרייה יחד. חלצו אותה (
tar --zstd -xf otzaria-linux-full.tar.zst) והריצו את run-otzaria.sh.
- בהרצה הראשונה של האפליקציה, תתבקשו להוריד את הספרייה.
- לחלופין, ניתן להוריד את הספרייה ידנית מ-כאן, לחלץ אותה ולספק את הנתיב שלה לאפליקציה.
Android
- האפליקציה זמינה ב-Google Play: קישור
- לחלופין, ניתן להוריד את קובץ ה-.apk מדף ה-releases ולהתקין אותו.
- עבור גרסאות רשמיות קיים גם חבילה מלאה (FULL):
otzaria-android-full.zip.
- החבילה המלאה ל-Android כוללת את ה-APK יחד עם תוכן הספרייה הלא-מקוון להפצה.
- בהרצה הראשונה של האפליקציה, תתבקשו להוריד את הספרייה.
- לחלופין, ניתן להוריד את הספרייה ידנית מ-כאן ולספק את קובץ ה-zip לאפליקציה.
iOS (אייפון/אייפד)
- האפליקציה זמינה ב-AppStore: קישור
- בהרצה הראשונה של האפליקציה, תתבקשו להוריד את הספרייה.
macOS
- הורידו את גרסת MacOS האחרונה מדף ה-releases.
- עבור גרסאות רשמיות קיים גם חבילה מלאה (FULL):
otzaria-macos-full.tar.zst.
- החבילה המלאה כוללת את האפליקציה והספרייה יחד. חלצו אותה בטרמינל (
tar --zstd -xf otzaria-macos-full.tar.zst; אם חסר zstd: brew install zstd) והפעילו את Run Otzaria.command.
- הריצו את האפליקציה תוך לחיצה על מקש ctrl.
- בהרצה הראשונה של האפליקציה, תתבקשו להוריד את הספרייה.
- לחלופין, ניתן להוריד את הספרייה ידנית מ-כאן, לחלץ אותה ולספק את הנתיב שלה לאפליקציה.
(⇧)
מפת דרכים
ראו את הבעיות הפתוחות לרשימה מלאה של תכונות מוצעות (ובעיות ידועות).
(⇧)
תרומה לפרויקט
תרומות הן מה שהופך את קהילת הקוד הפתוח למקום כה מדהים ללמוד, לתת השראה וליצור. כל תרומה שתתרמו מוערכת מאוד.
אם יש לכם הצעה שתשפר את הפרויקט, אנא בצעו fork למאגר וצרו pull request. ניתן גם פשוט לפתוח issue עם התגית "enhancement".
אל תשכחו לתת לפרויקט כוכב! תודה שוב!
- בצעו Fork לפרויקט
- צרו ענף תכונה משלכם (
git checkout -b feature/AmazingFeature)
- בצעו Commit לשינויים שלכם (
git commit -m 'Add some AmazingFeature')
- בצעו Push לענף (
git push origin feature/AmazingFeature)
- פתחו Pull Request
תנאי תרומה (חובה לקריאה)
בעצם פתיחת Pull Request, שליחת קוד, או עריכת תוכן קיים במאגר, התורם מסכים לתנאים הבאים — אלא אם צוין במפורש אחרת בכתב בעת מסירת התרומה:
- העברת זכויות והסכמה לרישוי: התורם מעביר לבעל הפרויקט (Otzaria Project) את מלוא זכויות היוצרים והקניין בתרומתו, או — לכל הפחות — מעניק רישיון בלעדי, עולמי, בלתי חוזר, ללא תמלוגים ועם זכות רישוי-מחדש, להשתמש בתרומה, לשנותה, להפיצה ולרשותה תחת כל רישיון, לרבות Personal Use License ורישיונות עתידיים.
- ויתור על תביעות: התורם מוותר על כל דרישה, תמלוג או תביעה בגין השימוש בתרומתו במסגרת הפרויקט או מיזמים נלווים לו.
- הצהרת בעלות: התורם מצהיר שהתרומה היא יצירה מקורית שלו ושהוא רשאי להעניק בה את הזכויות הללו, ושאינה מפרה זכויות של צד שלישי.
- שמירת קרדיט: מתן הקרדיט לתורם (ברשימת התורמים / היסטוריית הגיט) נשמר; אין באמור כדי לגרוע מזכותו המוסרית להיות מוכר כיוצר התרומה.
תרומה שאינה עומדת בתנאים אלו לא תיקלט במאגר.
מפתחות בנייה מקומיים
ערכים שאינם נשמרים בקוד המקור מוזרקים בזמן בנייה (--dart-define). כרגע אין ערך שחובה להזין,
אבל תצורת ההרצה ב-VS Code מצפה לקובץ, ולכן בפיתוח מקומי מעתיקים פעם אחת את קובץ הדוגמה:
cp dart_defines.example.json dart_defines.local.json
הקובץ dart_defines.local.json מוחרג מגיט. אחר כך מריצים כך:
flutter run --dart-define-from-file=dart_defines.local.json
ב-VS Code אין צורך בדגל — תצורת ההרצה .vscode/launch.json שבריפו כבר כוללת אותו (F5).
(⇧)
פתרון בעיות בבנייה (Build)
שגיאת תעודת SSL ברשתות מסוננות (NetFree וכדומה)
אם אתם נתקלים בשגיאת תעודת SSL בעת בנייה ל-Windows (למשל status_code: 60, CERT_TRUST_REVOCATION_STATUS_UNKNOWN), סביר להניח שהדבר נובע מסינון רשת.
לפתרון מפורט שלב-אחר-שלב, אנא עיינו ב-ויקי NetFree - מדריך הגדרת Flutter.
פתרון מהיר (PowerShell):
אם אתם זקוקים לעקיפה מהירה לפני הבנייה, הריצו:
$env:CMAKE_TLS_VERIFY="0"
flutter build windows
(⇧)
רישיון
הקוד המקורי של הפרויקט מופץ תחת:
Personal Use License 1.0 — שימוש אישי בלבד
פירוט מלא ברישיון
תנאי הרישיון בקצרה:
- מותר שימוש אישי ופרטי בלבד של אדם פרטי (הורדה, הרצה, לימוד ושינוי לצורך עצמי)
- אסור כל שימוש ציבורי — בין מסחרי ובין במסגרת תוכנה חינמית/קוד פתוח — ללא רשות מפורשת בכתב
- אסורה כל הפצה, פרסום, או שילוב במוצר/שירות/אתר/API
- אסור שימוש של חברה, עמותה, מוסד או כל גוף שהוא ללא רשות מפורשת בכתב
- חובת מתן קרדיט ל'אוצריא' נשמרת גם לאחר קבלת רשות
- לבקשת רשות: [email protected]
הערת מעבר: גרסאות של התוכנה שפורסמו לפני כניסת רישיון זה לתוקף היו תחת GPL-3.0, וזכויות שכבר ניתנו תחתיו אינן מבוטלות. רישיון זה חל על הגרסה הנוכחית ואילך, ובכפוף לזכויות של תורמים אחרים בקוד. רישיון זה חל רק על הקוד המקורי שלנו — רכיבי צד שלישי (ספריות, חבילות, גופנים ונכסים) נשארים תחת רישיונותיהם המקוריים, וכך גם הטקסטים והספרים המופצים בנפרד.
(⇧)
יצירת קשר
תמיכה: [email protected]
קישור לפרויקט: https://github.com/otzaria/otzaria
(⇧)
תודות
תוכנה זו נוצרה והוקדשה על ידי:
sivan22,
ר. נבון (השקעה עצומה במעבר ל-SQLite),
Y.PL.,
palmoni,
YOSEFTT,
zevisvei,
evel-avalim,
userbot,
mosh-dvd,
asz,
michaelush,
NHLOCAL (פיתוח "שמור וזכור").
תודה מיוחדת ל-אליהו גמבש על העבודה העצומה בהמרת נתוני ספריא ל-SQLite.
הפרויקט התאפשר בזכות הפרויקט המדהים של ספריא.
ובזכות עמותת דיקטה, שבאמצעותה נוספו ספרים חשובים רבים.
תודה למכון בית אהרן וישראל שע"י מרכז סטאלין קארלין, על האישור להכניס את ספריו לספרייה. כל הזכויות על ספרים אלו שמורות למכון.
מציג ה-PDF מופעל באמצעות pdfrx.
עבור עדכונים אוטומטיים, השתמשתי ב-updat.
Sefaria book conversion, the fuzzy search, and the library updates are powered by the technologies that drive Zayit — https://zayitapp.com/ (licensed under GNU AGPL v3).
(⇧)
