Skip to content

Latest commit

 

History

History
258 lines (180 loc) · 8.4 KB

README.md

File metadata and controls

258 lines (180 loc) · 8.4 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

gatewayAdmin

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

Go to Application · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Login Page Login

Setup Account Setup Account

View Resources view_resources

Purpose To provide a tool to Translation Team Administrators to easily create Gitea repos, create/update manifests, run checks, etc.

Problem The admins must be skilled Git users today and such activity is often error prone and time consuming.

Scope

  • Current scope is focused on helping with Git and other translation backend requirements.
  • It is envisioned that this tool might also:
    • Manage teams, translation assignments, issues, etc.
    • Provide a dashboard for at-a-glance status of translation projects

Background The unfoldingWord training teams spent copious amounts of time dealing with backend Gitea requirements to support the translation tools. Ongoing, the teams also spent a lot of time and required IT support to manage backend issues.

(back to top)

Built With

(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

  • Must have an account on DCS
  • The source must be cloned from its repository (see above)
  • yarn install is used to resolve/install dependencies
  • yarn dev is used to start the local server listening on localhost:3000

Installation/First Steps

  1. Get a DCS account
  2. Clone the repo 
    git clone https://github.com/unfoldingword/gateway-admin.git
  3. Install NPM packages 
    yarn install
  4. Enter your API in config.js 
    const API_KEY = 'ENTER YOUR API';

Be sure to review TESTING.md for comprehensive testing notes and instruction on running cypress tests.

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

(back to top)

Contact

Cecil New

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

(back to top)