search

friendsofagape / autographa-live

A Bible translation editor for everyone. Now live.
http://autographa.org
GNU General Public License v3.0
6 stars 3 forks source link
bible-translation easy-to-use editor electron javascript minimal open-source reactjs

readme

Autographa Live

This is a standalone desktop application which hopes to aid and be a friendly companion of the Bible Translator. In essence it is a basic USFM editor which is capable of import and export of USFM files. It has handy features like color-coded diffs across imported texts for comparison between revisions, search and replace and export to formatted HTML.

The crucial difference with Autographa Lite is that Autographa Live will include capabilities for syncing data with online repositories and that this application is licensed differently.

Both 'Lite' and 'Live' versions will continue being supported and developed.

Developer Setup

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

Prerequisites

Node JS 12.6.0.
npm 6.9.0
Python 2 (One of our build tools breaks under Python 3.)

Build and run

  1. Fork and clone this repository
  2. Set environment variable ELECTRON_BUILDER_ALLOW_UNRESOLVED_DEPENDENCIES=true
  3. Set npm config set '@bit:registry' https://node.bit.dev
  4. Install dependencies with npm install
  5. Start the application with npm start

Mac and *nix (tested on MacOS Sierra 10.14 and Ubuntu 19.04)

In Bash-like shell:

export ELECTRON_BUILDER_ALLOW_UNRESOLVED_DEPENDENCIES=true    
cd autographa-live && npm install    
npm start

Windows (tested on Windows 10)

In Command Prompt:

cd autographa-live
set ELECTRON_BUILDER_ALLOW_UNRESOLVED_DEPENDENCIES=true
npm install
npm start

Known Issues

Autographa Live (as of now) supports minimal tags and therefore is not ideal for importing heavily tagged data, as these would be ignored and would not be recoverable later. Therefore, importing from Paratext Cloud should be done with this in mind as it may cause data loss and unwanted changes in formatting.

The intended workflow is for users to start drafting in Autogrpaha Live and then upload/export these in to more feature-rich/heavy editors like Paratext and should not be done the other way round unless for minor updates.

Contributing

If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome. Please read the CONTRIBUTE page for details on our code of conduct, and the process for submitting pull requests.

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

License

This project is licensed under the GNU GENERAL PUBLIC LICENSE (Version 3) License. See LICENSE for more details.

Contact

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

Acknowledgments