Obt
Open Bible Text
Install / Use
/learn @hiscoder-com/ObtREADME
<!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details>
<!-- ABOUT THE PROJECT -->
About The Project
Purpose
-
Enable churches to read and study Scripture and OBS in their own language using all the opensource materials from git.door43.org
-
Give translators the opportunity study the Scriptures using all the opensource materials from git.door43.org
Problem
- There are many resources that are already translated, but there was no tool for easy reading and learning
- Small nations do not always have the resources to publish their work
Scope
- Local second (Windows, Mac, Linux)
- Downloadable
- Also usable online
- Sideloading
- Full book package support for browsing, viewing, listening
- Proskomma (search, versification, etc.)
- Text Annotator (shareable user generated notes) via Datatable editable
- Scripture commenting/reporting system
- Progressive Web App
- Downloadable for language-resource combinations via Catalog Next React Toolkit
Background
- We wanted to make a website that would help share the work done and help spread the Gospel
Built With
<p align="right">(<a href="#top">back to top</a>)</p> <!-- GETTING STARTED -->Getting Started
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
<br/>Prerequisites
All data in OPEN BIBLE TEXT is taken from Door43 Catalog
<br/>Data
- The source must be cloned from its repository
yarn installis used to resolve/install dependenciesyarn startis used to start the local server listening onlocalhost:3000
Local
- Yarn 1.x: please refer to their installation guide.
Installation/First Steps
-
Clone the repo
git clone https://github.com/texttree/bsa.git -
Install NPM packages
yarn install -
Copy
.env.exampleand rename it -
Run the project with the command
yarn start
Additional setting
Configuring Error Sending
-
Configuring backend for error reporting: https://github.com/texttree/tsv-send-backend
-
Enter your URL in
.envfile inREACT_APP_SERVER_LINKvariable
Configuring Feedback Sending
In our environment, we use lambda functions netlify and telegram bot.
You need to specify the bot token and chat ID in the .env file in API_TELEGRAM_TOKEN and GROUP_TELEGRAM variables
Set up new language support
You can configure resource language support in the config folder
In progress...
<p align="right">(<a href="#top">back to top</a>)</p><!-- USAGE EXAMPLES -->
Usage/Integration
User`s guide
<p align="center"><img src="./src/docs/images/interactive_guide.png"> </p>Select BIBLE/OBS mode
<p align="center"><img src="./src/docs/images/obs.png"> </p>Main menu
<p align="center"><img src="./src/docs/images/main_menu.png"> </p>Add resources
<p align="center"><img src="./src/docs/images/add_resource_languages.png"> </p>Settings
<p align="center"><img src="./src/docs/images/settings.png"> </p>Layout list
<p align="center"><img src="./src/docs/images/layout_list.png"> </p>Import layout
<p align="center"><img src="./src/docs/images/import_layout.png"> </p>Report a typo
<p align="center"><img src="./src/docs/images/error_message.png"> </p> <p align="right">(<a href="#top">back to top</a>)</p><!-- ROADMAP -->
Roadmap
See the open issues for a full list of proposed features (and known issues).
This project uses Zenhub to manage the roadmap.
<p align="right">(<a href="#top">back to top</a>)</p><!-- CONTRIBUTING -->
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. Guidelines for external contributions.
You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
If you would like to fork the repo and create a pull request.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
<!-- LICENSE -->
License
Distributed under the MIT License. See LICENSE for more information.
<!-- CONTACT -->
Contact
Texttree - Discord
Help us translate - Crowdin
Project Link: https://github.com/texttree/bsa
<p align="right">(<a href="#top">back to top</a>)</p>