gatewaytranslate

This application is for use by Gateway Language translators.
Explore the docs »

Go to Application · Report Bug · Request Feature

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

Login Page

Setup Account

View Texts

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

Problem There are few (if any) web based editors for USFM markup, especially focused on translation activities.

Scope

• Current scope is focused on editing USFM text and doing alignments with the original language texts.
• It is envisioned that this tool also:
  • Enable translation of Bibilical Resources (translation notes, questions, etc.)
  • Supersede the existing tooling in unfoldingWord® for translation tasks

Background This project 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

• Next.js
• React.js

(back to top)

Getting Started

Installation/First Steps

1. Get a DCS account
2. Clone the repo

   git clone https://github.com/unfoldingword/gateway-translate.git

3. Install NPM packages

   yarn install

4. Start the local server

   yarn dev

5. Visit localhost:3000

(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

Finally, you can point the application to either the QA or Production servers this way:

To use QA add the "server=qa" parameter to the URL: https://gateway-edit.netlify.app/?server=qa.

This is a toggle and will stay pointed at QA until another setting is applied.

To point to production: https://gateway-edit.netlify.app/?server=prod

(back to top)

License

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

(back to top)

Contact

Cecil New

• Twitter @mandolyte
• Discord Cecil#5551

Project Link: https://github.com/unfoldingword/gateway-translate

(back to top)