Skip to content

nafi052/BavliManager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BavliManager

Build and Test License: MIT

BavliManager is a Java application for indexing, searching, and studying Talmud Bavli content, including personal notes and export tools.

מנהל בבלי: זהו כלי Java לניהול תוכן תלמודי, חיפוש, הערות אישיות וייצוא.

Quick Start (EN)

Requirements

  • JDK 17
  • Maven 3.8+

Build, test, verify

mvn clean test verify

Run the app

mvn compile exec:java -Dexec.mainClass="bavli.Main"

Data notes

  • The repository includes minimal sample data under pages/ברכות/ for CI/testing.
  • For full content preparation, use menu option 6 to split bavli.txt into tractate/page structure.

התחלה מהירה (עברית)

דרישות

  • JDK 17
  • Maven 3.8+

בנייה והרצת בדיקות

mvn clean test verify

הרצת האפליקציה

mvn compile exec:java -Dexec.mainClass="bavli.Main"

הערות על נתונים

  • הריפו כולל דוגמת נתונים מינימלית תחת pages/ברכות/ לצורכי CI ובדיקות.
  • להכנת נתונים מלאים, ניתן להשתמש באפשרות 6 בתפריט כדי לפצל את bavli.txt למבנה מסכת/דף.

Features / תכונות

  • Index loading and mishna indexing / טעינה ובנייה של אינדקסים
  • Chapter/tractate search / חיפוש לפי פרק ומסכת
  • Personal notes management / ניהול הערות אישיות
  • HTML export / ייצוא ל-HTML
  • Caching and performance helpers / מטמון ואופטימיזציית ביצועים

Project Structure

  • src/ - Java source (package bavli)
  • src/test/java/ - JUnit tests (incremental migration)
  • pages/ - Tractate/page folders
  • lib/ - Optional external jars
  • user_notes/ - Local personal notes

Testing Strategy

  • mvn test runs JUnit tests.
  • mvn verify also runs the existing internal test runner (bavli.Tests) via Maven exec during verify.
  • This dual setup supports gradual migration toward standard JUnit coverage.

Contributing & Security

License

MIT — see LICENSE.

About

Java toolkit for indexing and studying Talmud Bavli content

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages