OPEN BIBLE TEXT

An application for advanced Bible study using opensource materials from git.door43.org.

View Production · View Develop · Report Bug · Request Feature

Help us translate - Crowdin

---

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

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

(back to top)

---

Built With

• React.js
• Material-UI

(back to top)

---

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.

Prerequisites

All data in OPEN BIBLE TEXT is taken from Door43 Catalog

Data

• The source must be cloned from its repository
• yarn install is used to resolve/install dependencies
• yarn start is used to start the local server listening on localhost:3000

Local

• Yarn 1.x: please refer to their installation guide.

Installation/First Steps

1. Clone the repo

   git clone https://github.com/texttree/bsa.git

2. Install NPM packages

   yarn install

3. Copy .env.example and rename it

4. Run the project with the command

   yarn start

Additional setting

Configuring Error Sending

1. Configuring backend for error reporting: https://github.com/texttree/tsv-send-backend

2. Enter your URL in .env file in REACT_APP_SERVER_LINK variable

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

(back to top)

---

Usage/Integration

User`s guide

Select BIBLE/OBS mode

Main menu

Add resources

Settings

Layout list

Import layout

Report a typo

(back to top)

---

Roadmap

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

This project uses Zenhub to manage the roadmap.

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

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

Distributed under the MIT License. See LICENSE for more information.

(back to top)

---

Contact

Texttree - Discord

Help us translate - Crowdin

Project Link: https://github.com/texttree/bsa

(back to top)

---

Acknowledgments

• unfoldingWord
• Zach P
• Klappy
• Abel Pérez
• Mark Howe

(back to top)