Scribe Scripture Editor (Scribe SE)

A Bible translation editor for everyone.
Report Issue · Feature Request

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Scribe SE is a standalone desktop application which aims to aid and be a friendly companion for the Bible Translator. It is composed of modes which support focus on specific use-cases e.g. text translation (USFM-based editor), Oral Bible translation (audio recorder) and Open Bible Story (in Markdown format) drafting mode. It supports syncing with online repositories for data backup and other such helpful features.

Built With

• ReactJS
• Electron
• Tailwind CSS

Getting Started

It is relatively easy to setup the application locally for development.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Node.js ^16.15.1
• YARN ^1.22.19

Installation

1. Fork and clone this repository
2. Install dependencies with yarn install
3. Start the application with yarn start
4. Checkout the web version with yarn dev Runs the app in the development mode.
   Open http://localhost:3000 to view it in the browser.

Roadmap

See the projects page for a list of proposed features and known issues we are working on.

Contributing

If you'd like to contribute, please fork the repository and commit changes in your fork. Pull requests are warmly welcome.

We really value our contributors whether they helped fix a bug, built a feature, tested out the app or contributed in some other way.

The process for submitting pull requests.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/NewFeature)
3. Create logs as you start making changes

Logger level:
Production => warn
Development => debug

Usage: logger.[level]("<filename>, <message>")

4. Add nessesary propTypes for all the properties passed to react component (https://github.com/facebook/prop-types)
5. After adding features make sure you write test for that using:

• Jest
• React Testing Library

6. Run yarn lint:fix for code to adapt our linting rules
7. Run yarn build for build checks
8. Commit your Changes (git commit -m 'Add some NewFeatures')
9. Push to the Branch (git push origin feature/NewFeature)
10. Open a Pull Request and make sure all checks have passed

License

This project is licensed under the MIT License. See LICENSE for more details.

Contact

Let us know if you face any bugs/problems by opening an issue on GitHub. We'll do our best to be prompt in our response.

Acknowledgements

• Supported by the Open Components Ecosystem.
• Developed and maintained by Bridgeconn