gateway-edit-POC

Demo Repo Issues

GatewayEdit-POC

Displaying the English source text for the current TranslationNote within gatewayEdit

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

• gatewayEdit is a superior tool to tC Create with a better interface
• We need to test if it makes sense to have two repos for the same resource within gE
• We need to know if there are any major blockers to adding a translation mode to gE.

Problem

• Currently gatewayEdit app doesn't show the source resources.

Scope

• It is possible to show the source view but only the challenging part is - how to manage the space

Background (Contextual situations)

• When users want to compare a resource to the English source text
• When users want to translate a resource from the English source text

(back to top)

Built With

• Next.js
• React.js
• Material UI
• RCL's

(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

Data

https://qa.door43.org/

Installation/First Steps

1. Clone the repo

git clone https://github.com/unfoldingWord-box3/gateway-edit-POC.git

2. Go to directory

cd gateway-edit-POC

3. Install NPM packages

yarn install

4. To start

yarn dev

(back to top)

Usage

Create an account

• Create an account(signin/signup)
• Select organisation and language
• Click SAVE AND CONTINUE button(You will get a page where you can refer and edit the content in translation Notes card).

Change Books/chapter

• On header use left and right arrows to navigate through books and chapters

Acount setting

• Here you can change or switch oraganisation and language

Reset layout

• Click on Reset Layout in the drawer to reset the card layouts

logout

• Click on logout to exit the application

(back to top)

Roadmap

• Setup the Project locally
• Understand the base code (GWE)
• Display the Source resources in translation note card

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

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

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.txt for more information.

(back to top)

Contact

• @Jincy - [email protected]
• @Joel C - [email protected]

Project Link: GatewayEdit-poc

(back to top)

Acknowledgments

We would like to express our special thanks of gratitude to UW teams who gave us the golden opportunity to do this wonderful project, which also helped us in doing a lot of Research and we came to know about so many new things. We are really thankful to team.

(back to top)