https://github.com/Sivan22/otzaria
A modern app that brings the jewish library to every device
https://github.com/Sivan22/otzaria
e-books flutter judaism torah
Last synced: 7 months ago
JSON representation
A modern app that brings the jewish library to every device
- Host: GitHub
- URL: https://github.com/Sivan22/otzaria
- Owner: Sivan22
- License: unlicense
- Created: 2024-02-01T23:17:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-23T14:38:42.000Z (7 months ago)
- Last Synced: 2025-02-23T15:32:26.282Z (7 months ago)
- Topics: e-books, flutter, judaism, torah
- Language: Dart
- Homepage: http://www.otzaria.org/
- Size: 2.71 GB
- Stars: 128
- Watchers: 12
- Forks: 23
- Open Issues: 152
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
![Downloads][Github-downloads]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
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 a Bug
·
Request A Feature
·
User manual
Table of Contents
## About The Project
I felt the lack of an open source app of the jewish library, for PCs.
Torat Emet 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 remain ALWAYS 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 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 easily and effectively anytime and anywhere.
### Built With
* [![Dart][dart]][Dart-url]
* [![Flutter][Flutter]][Flutter-url]
I Chose 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.
## Getting Started
### windows
#### Prerequisites
Make sure that Visual C++ Redistributable is installed on your computer. if not, download it from [Here](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170) and install it.
#### Installation
Download the latest build for windows from [releases](https://github.com/Sivan22/otzaria/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, extract and run Otzaria.
* When first running the app, you will be asked to download the library.
* Llternatively, you can download the library manually from [here](https://github.com/Sivan22/otzaria-library/releases), extract it and provide its 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 manually from [here](https://github.com/Sivan22/otzaria-library/releases) and provide the zip file to the app.
### iOS (iPhone/iPad)
* You can try the beta version through TestFlight.
* Follow this [link](https://testflight.apple.com/join/yvNbmaX4).
* 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 the ctrl key.
* When first running the app, you will be asked to download the library.
* Alternatively, you can download the library manually from [here](https://github.com/Sivan22/otzaria-library/releases), extract it and provide its path to the app.
## Usage
See the Wiki section for documentation.
## 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
- [X] Hebrew
See the [open issues](https://github.com/sivan22/otzaria/issues) for a full list of proposed features (and known issues).
## 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
## License
The code is totally open-sourced under the [Unlicense](https://unlicense.org/) license.
The texts have different open licenses. You may check Sefaria's site for more info on that.
## Contact
Sivan Ratson- - sivan.ratson@gmail.com
Project Link: [https://github.com/sivan22/otzaria](https://github.com/sivan22/otzaria)
## Acknowledgments
The project was possible because of Sefaria's amazing project.
and Dicta association, by which many important books were added.
The PDF viewer is powered by [pdfrx](https://pub.dev/packages/pdfrx).
For automatic updates, I used [updat](https://pub.dev/packages/updat).
[contributors-shield]: https://img.shields.io/github/contributors/sivan22/otzaria.svg?style=for-the-badge
[contributors-url]: https://github.com/sivan22/otzaria/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/sivan22/otzaria.svg?style=for-the-badge
[forks-url]: https://github.com/sivan22/otzaria/network/members
[stars-shield]: https://img.shields.io/github/stars/sivan22/otzaria.svg?style=for-the-badge
[stars-url]: https://github.com/sivan22/otzaria/stargazers
[issues-shield]: https://img.shields.io/github/issues/sivan22/otzaria.svg?style=for-the-badge
[issues-url]: https://github.com/sivan22/otzaria/issues
[Github-downloads]: https://img.shields.io/github/downloads/sivan22/otzaria/total.svg?style=for-the-badge
[license-shield]: https://img.shields.io/github/license/sivan22/otzaria.svg?style=for-the-badge
[license-url]: https://github.com/sivan22/otzaria/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/othneildrew
[product-screenshot]: images/screenshot.png
[dart]: https://img.shields.io/badge/dart-000000?style=for-the-badge&logo=dart&logoColor=61DAFB
[Dart-url]: https://dart.dev/
[Flutter]: https://img.shields.io/badge/Flutter-20232A?style=for-the-badge&logo=flutter&logoColor=61DAFB
[Flutter-url]: https://flutter.dev/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com