Contributors · Original Upstream App, of which this is a Fork · MIT License

Offline Fork of gatewayTranslate

This application is for use by translators who want or need to work offline.
Windows Pre-Release v0.0.18-poc+001 · Preview Online

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Install Windows Pre-Release or Preview Online
   • To Recreate Electron Forge Make
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Upload Zipped USFM Files

View Texts

Purpose To provide a tool for Translation Teams to edit, translate, and align Scripture Texts offline, which are typically in USFM format.

Problem There are few (if any) offline editors for edit, translate, and aligning USFM markup, especially focused on translation activities.

Scope

• Current scope is focused on editing USFM text and indicating alignment with the original language texts.

Background This project is a fork of unfoldingWord's Gateway Translate, and uses components from the Open Components Ecosystem (OCE) extensively. In particular it relies on Proskomma, a scripture runtime engine for the editor component itself. The latter is also contributed to the OCE community and we welcome others to reuse it.

(back to top)

Built With

• Electron Forge
• Next.js
• React.js

(back to top)

Getting Started

Install Windows Pre-Release or Preview Online

• Add font-detect-rhl
• Windows Pre-Release v0.0.18-poc+001
• Preview Online

To Recreate Electron Forge Make

1. Clone the repo

   git clone https://github.com/RUN-Collaborations/gateway-translate.git

2. Install packages

   yarn install

3. Start the local server with or without Electron
   • yarn dev then visit localhost:3000,
   • Or yarn predev then use the Electron window or visit localhost:3000.
4. Build and Export

   yarn build && yarn export

5. Manually change .next/ to relative paths
   • In .next\server\pages\*.html and .next\static\chunks\main-*.js replace: "/_next/ with: "../../.
   • Launch .next\server\pages\*.html in a local web browser and click through to confirm relative paths are setup as needed.
6. Package or Make

   yarn package

   • Then review /out/,
   • Or:

   yarn make

   • Then review /out/make/.

(back to top)

Roadmap

• The Getting Started steps above leave .next\static\css\*.css looking for NotoSans-Regular.ttf and NotoSans-Bold.ttf in /static/. These needs to be manually added or factored into the build process for it to be able to find them.
• Add font-detect-rhl
• Add alignment capability
• Facitilate starting of new projects rather than assuming import of existing projects\
• Add MacOS and Linux installation files
• Leverage Electronite Forge once available

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

You can also simply open an issue with the tag "enhancement".

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)