mendelg / otzaria_repo

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

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.
• 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

the app is still in development. so there is no installation package yet. you can download the zip from the GitHub repo, unzip it, and run the app.

Prerequisites

windows

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

Installation

windows and linux

• download the full zip (including the library) from the releases page, unzip it, and run the app.
• when first running the app, provide the path to the library. the path should be inside the unzipped folder.

android

• Download the apk from the releases page, and install it.
• download the library from the releases page, and unzip it on your device.
• when first running the app, provide the path to the library. the path should be inside the unzipped folder.

(back to top)

Usage

See the Wiki section for documentation.

(back to top)

Roadmap

• Add ViewModel layer
• Transfer database to isar
• language Support
  • English
  • Hebrew
• full-text search with index
• add more features
  • search for references
  • save history

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- - [email protected]

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

(back to top)

Acknowledgments

the project was avavilable because of Sefaria's amazing project.

the PDF viewer is powered by pdfrx.

for automatic updates, i used updat.

(back to top)