Otzaria

Making the jewish library accessible to everyone by creating an app with a modern UI/UX, that could run on any device
See our site »

Report Bug · Request Feature · user's manual

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

I felt the lack of an open source app of the jewish library, for PCs.

Torat Ememt is old and no longer maintained, and Sefaria's app is great, however, it does not work well on computers.

So i decided to make one myself. I did not know Dart and Flutter at all in the beginning, but it was fun. I love to learn new technologies!

The database itself is accessible to everyone following the important work of the Sefaria organization, so a big thank to them for that.

Key features of the project:

• the software is FREE and will be ALLWAYS FREE.
• Built to work effeciently on any device, including Windows, Linux, and Android.
• The app is designed to be as user friendly as possible.
• A thorough selection process has been undertaken to ensure that the books are suitable for the Torah community
• the library is flexible, means that you can add or remove books from the library.
• fast search engine, including the user-added books.
• the app supports the following formats: TXT, Docx and PDF.

I hope that my work will help the Torah community to learn easiely and effectively anytime and anywhere.

(back to top)

Built With

• 
• 

I Choose to use Dart and Flutter. I think that is the most efficient and most modern way to build a GUI app.

Also, it is a multiplatform framework.

(back to top)

Getting Started

windows

Prerequisites

make sure that Visual C++ Redistributable is installed on your computer. if not, download it from Here and install it.

Installation

download the latest build for windows from releases. the library is included in the .exe file. in case you need only the app itself (for upgrading) you can download the .msix file.

linux

Prerequisites

sudo apt-get install libgtk-3-0 libblkid1 liblzma5

Installation

• download the linux build from releases, extarct and run otzaria.
• when first running the app, you will be asked to download the library.
• alternatively, you can download the library manualy from [here], extarct it and provide path to the app.

android

• Download the .apk file from the releases page, and install it.
• when first running the app,.you will be asked to download the library.
• alternatively, you can download the library manualy from [here] and provide the zip file to the app.

iOS (iPhone/iPad)

• you can try the beta version through TestFlight.
• follow this link.
• when first running the app,.you will be asked to download the library.

macos

• download the latest macos build from the releases page.
• run the app while pressing ctl.
• when first running the app, you will be asked to download the library.
• alternatively, you can download the library manualy from [here], extarct it and provide path to the app.

(back to top)

Usage

See the Wiki section for documentation.

(back to top)

Roadmap

• Add business logic layer by switching the state management library to Bloc.
• Transfer books data from text files to SQLite database
• add option for semantic search using an embedding ML model and vector database
• language Support
  • English
  • Hebrew

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

the code is currently Unlicensed. it may change in the future, but it will allways stay open-sourced.

the texts has different open licenses. you may check Sefaria's site for more info on that.

(back to top)

Contact

Sivan Ratson- - sivan.ratson@gmail.com

Project Link: https://github.com/sivan22/otzaria

(back to top)

Acknowledgments

the project was avavilable because of Sefaria's amazing project.
and Dicta association, by which many important books were added.

the PDF viewer is powered by pdfrx.

for automatic updates, i used updat.

(back to top)