tim (Translation & Internationalization Manager)

Table of contents

1. Project overview
2. Functionalities
3. Demo applications
4. Technical details
5. Technologies
6. Installation guide (developers)
7. Installation guide (users)
8. Docker
9. Contributing

1. Project overview

Tool enhancing cooperation between teams of developers and translation agencies.

Main features:

• allowing programmers to add to the system messages that require translations
• good integration with other systems used in software development, that is:
  • exporting reports with missing translations
  • exporting ready translations in format acceptable by Spring applications

2. Functionalities

For super-admin:

• in progress...

For programmer:

• uploading CSV report with messages to be translated
• adding, updating and archiving messages throught UI
• browsing message and translations history
• browsing summary of translation progress for all projects
• invalidating translations (not implemented)

For programmer-admin:

• in progress...

For translator:

• export CSV report with messages that need translations
• upload of CSV report with translations
• adding, updating and invalidating translations through UI
• using substitute translations with single click
• browsing message and translations history

For translator-admin:

• in progress...

For external applications connected via continous integration endpoints:

• get list of supported locales
• get file with translated messages for given locale

3. Demo application

None are live at the moment.

• Frontend
  • https://studentproject-tim-frontend.herokuapp.com
• Backend
  • https://studentproject-tim-backend.herokuapp.com

4. Technical details

Accounts available in project:

• tran / tran / ROLE_TRANSLATOR
• prog / prog / ROLE_DEVELOPER
• adminTran / adminTran / ROLE_ADMIN_TRANSLATOR
• adminProg / adminProg / ROLE_ADMIN_DEVELOPER
• admin / admin / ROLE_SUPER_ADMIN

5. Technologies

• Backend
  • Java 11
  • Spring 5
  • JUnit 5
  • Mockito 2
• Frontend
  • Angular 10
  • Angular Material 10
• Other
  • Swagger UI 2.0

6. Installation guide (developers)

Backend:

1. Install prerequisites (OpenJDK 11, maven)
2. Run mvn clean install for backend and auth_server applications
3. Run application with mvn spring-boot:run

Frontend:

1. Install prerequisites according to this guide https://angular.io/guide/quickstart (Node.js, node package manager, Angular)
2. Go to /frontend folder.
3. Run npm i to install dependencies.
4. Run ng serve to start the application. App will be available at localhost:4200.

7. Installation guide (users) - OUTDATED

1. Install docker
2. Pull backend and frontend project from dockerhub:
   • docker pull studentproject/ocado-tim-backend
   • docker pull studentproject/ocado-tim-frontend
   • docker pull studentproject/simple-web-app
3. Run postgresql database
   • docker run -it -p 5432:5432 -d -v :/var/lib/postgresql/data postgres
     • where path to database directory is path to place where all database data are kept e.g.
       • docker run -it -p 5432:5432 -d -v /var/database:/var/lib/postgresql/data postgres
4. Run apps:
   • docker run -it -p 4200:4200 -d studentproject/ocado-tim-frontend
   • docker run -it -p 8081:8080 -d studentproject/ocado-tim-backend
   • docker run -it -p 8080:8080 -d studentproject/simple-web-app
5. The app is available on localhost or address 192.168.99.100 (depends on os)

8. Docker:

0. Login

• docker login
  • Username: studentproject
  • Password: ask Wojtek :)

1. Backend (tim directory)
   • mvn clean package
   • docker build -t studentproject/ocado-tim-backend:latest ./
   • docker push studentproject/ocado-tim-backend:latest
2. Frontend (tim/frontend directory)
   • npm run build
   • docker build -t studentprojecct/ocado-tim-frontend:latest ./
   • docker push studentproject/ocado-tim-frontend:latest
3. Presentation app (tim/example_app directory)
   • mvn clean package
   • docker build -t studentproject/simple-web-app:latest ./
   • docker push studentproject/simple-web-app:latest

9. Contributing

• Wojciech Spoton
• Jacek Zalewski
• Mikołaj Banaszkiewicz
• Alex Kostiukov
• Jacek Klimczak