https://github.com/correct-syntax/bible_side
An offline Bible app featuring the OET (Open English Translation)
https://github.com/correct-syntax/bible_side
android-app app bible bible-app flutter flutter-app scripture stacked-architecture
Last synced: 10 months ago
JSON representation
An offline Bible app featuring the OET (Open English Translation)
- Host: GitHub
- URL: https://github.com/correct-syntax/bible_side
- Owner: Correct-Syntax
- License: gpl-3.0
- Created: 2023-10-30T17:25:51.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T16:00:55.000Z (over 1 year ago)
- Last Synced: 2024-05-22T16:02:57.158Z (over 1 year ago)
- Topics: android-app, app, bible, bible-app, flutter, flutter-app, scripture, stacked-architecture
- Language: Dart
- Homepage:
- Size: 7.76 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[Bibleside](https://bibleside.com) is an offline Bible app featuring the OET (Open English Translation).
The [OET (Open English Translation)](https://openenglishtranslation.bible) is a new, open-licensed Bible translation (currently in ``draft`` state) featuring multiple versions intended to be used together. Read it [here](https://openenglishtranslation.bible/Reader). Please see the OET website for more info on what makes it different than other translations.
Bibleside implements the OET's "Reader's" version in the main area and a toggle to show the "Literal" and "Reader's" versions side-by-side. The two can be scrolled together for easy comparison.
## Try the app
**Bibleside is currently in closed testing on Google Play. [Click here](https://play.google.com/apps/testing/com.bibleside.bibleside) to become a tester and provide early alpha version feedback.** The same alpha version of the Bibleside app can also be found on [F-droid](https://f-droid.org/en/packages/com.bibleside.bibleside/) if you prefer.
## Bible versions
- [x] Open English Translation [Readers Version](https://openenglishtranslation.bible/Design/ReadersVersion)
- [x] Open English Translation [Literal Version](https://openenglishtranslation.bible/Design/LiteralVersion)
- [x] King James Version
- [ ] King James Version with Strongs numbering
- [ ] WEB (World English Bible)
Others?
## TODO
- Need to fix issue with standard single quotes in the HTML.
## Feedback/contributing
Feedback and contributions are welcome. To help out, ask questions, or share feedback please [join the Bibleside chat](https://matrix.to/#/#bibleside:matrix.org) on Matrix.
## Development
Bibleside is built with Flutter using [Stacked Architecture](https://stacked.filledstacks.com/).
- Run ``flutter pub get`` to install the dependencies.
- Choose an emulator or a connected device.
- Hit ``F5`` to run the code in the emulator, or open a terminal and run with ``flutter run``.
## Roadmap
[Bibleside Roadmap](https://github.com/users/Correct-Syntax/projects/2/views/7)
## Note on Bible versions
Bible versions are treated as separate Bibles. e.g: The OET-RV and OET-LV are treated as a separate bible version.
## OET file conversion
There is a Python script in ``/assets/bibles`` that will automatically update the json files from the GitHub sources.
The ESFM (a subset of USFM) files from [here (OET Reader's version)](https://github.com/Freely-Given-org/OpenEnglishTranslation--OET/tree/main/translatedTexts/ReadersVersion) and [here (OET Literal version)](https://github.com/Freely-Given-org/OpenEnglishTranslation--OET/tree/main/intermediateTexts/auto_edited_VLT_ESFM) are run through [usfm-grammar](https://github.com/Bridgeconn/usfm-grammar) conversion to JSON.
Navigate to ``/assets/bibles`` and run the file with ``python update_OET_json.py``.
## Updating the OET sections
After converting the OET ESFM to json, navigate to the folder with ``cd assets/bibles`` and run ``python update_OET_sections.py``. This will generate a dart file mapping the OET sections for use in Bibleside. Move back to the root folder with ``cd ../..`` and run ``dart format ./lib -l 120`` to format the file.
## License
Bibleside is licensed under the GPL-3.0 license. See LICENSE for more information.