Project creation

[vipinpaul]

- [x] Create a text translation project UI (ET -4 hrs) [ATT - 3.75hrs]

QA

• Testcase writing - Roslin (ET:1 hours)(ATT : 1 hour)
• Testcase Review - Seema (ET:15 min)(ATT: 15 mins)
• Testing - Roslin (ET: 3 hour)
• Testing Review - Seema(ET: 30mins)

SP3

• Fields for the Project name*, and description with Validation (ET -2hrs) [ATT- 1.25 hrs]
• Source* and Target language* selection with Validation (ET-8hrs) [ATT - 7hrs]
• Adding source USFM files* and validate them (ET- 8hrs) [ATT-9hrs]
• Import USFM files for target and validate them (ET- 6hrs) [ATT-6hrs]

Advance Options

• A directory picker (ET-5hrs) [ATT-4hrs]
• Selecting License (ET - 5hrs) [ATT-1hr]
• Convert the source USFM files to USJ files (ET-8hrs) [ATT-6hrs]

SP4

• Use the source USJ files to create target USJ files (ET-8hrs ATT 8hts) - Vipin

SP
Backend structure for storing the data

• Work on the text translation project creation using the below workflow (ET-6hrs)
• Have a centralized place for storing projects (ET-8hrs) [ATT-7hrs]

project (-uuid)
- scripture:textTranslation-8mQkv7
- MAT.usj (content)
- metadata.json
- scripture:audioTranslation-uuid
- MAT (content directory)
- 1
- 1-1-f-uuid.wav
- 1-1.mp3
- metadata.json

- metadata.json
- alignment.json

QA

• Testing - Roslin (ET: 4 hour)(ATT: 1.5 hour)(ATT: 4hour)(ATT: 1 hour)
• Testing Review - Seema(ET: 1hour)( ATT : 30 mins)(ATT: 1 hour)(ATT: 20 mins)

[Roslin22]

Test Result:

• The user is able to run the Electron app to create a project.
• The user is able to open a new project window.
• The mandatory fields are validated, and an error message is displayed if they are incorrect.
• The fields that are tested include Project Name, Source Language, Target Language, and Source USFM File.
• With valid inputs, the user is able to create the project, and a success message appears on the page.
• The created project can be viewed in the .scribe folder inside the home directory.
• With empty description user can create the project

As discussed with Vipin, the following functionalities have been tested:

Functionality Tested

• Project creation with valid inputs and verifying the success message.
• Validating the USFM file inside the source file tab.
• Invalid File Check: The system validates and checks the invalid file format, displays the error message, and prevents project creation.
• Verified that the drop-down open correctly and enable easy language search.

Environment

The electron app

Screen shots

[vipinpaul]

Things completed

• Project creation UI
• It has fields:- Project name, description, Source language selection, Target Language selection, Source Files selector, Target files selectors
• In advanced options - Location and License field.
• The mandatory fields are validated, and an error message is displayed if incorrect.
• The language selection dropdown has a search option; it loads data on scroll, and displays language_name(anglicized_name);language_code i.e Malayalam (മലയാളം); ml
• Source & Target file selector allows to select USFM & SFM files, it opens a new tab for displaying the usfm validation result.
• Location is set from the backend. can select a new location, but it doesn't allow to create the project in new location.
• Proper structure is being created in the backend in - .scribe/projects/
• Same structure hindi-00kw9pmv.zip

Things Left

• Target file selector is not working as expected; backend implementation is pending.
• Setting the new location for the project.
• Burrito implementation is pending.
• License part is also pending.

[Roslin22]

Moving this issue to QA, for a QA comments.

[Roslin22]

Test Results: Pass

The project creation functionality is working as expected.

• A validation error message appears for the mandatory fields.

• The user is able to select both the source and target languages, and the selected value is retained and highlighted in the dropdown menu.

• The user is able to create a project even without filling in the non mandatory fields. The user is able to upload a USFM file, and the file path is visible to the user.

• Upon clicking "View More Details," the user is able to view the USFM files. When clicking on the uploaded USFM file, a valid file message is displayed.

• The user is able to upload an invalid USFM file but is not able to create the project. An error message appears below the source USFM input field.

• The user is able to upload the target USFM file and validate it successfully.

• The user is able to upload an invalid target USFM file, but cannot create the project. An error message appears below the target USFM input field.

• Upon clicking the "Advanced Options," the user is able to view the location field with the default folder location, along with the license field.

• With valid details, the user is able to create the project, and a successful creation message is displayed.

• The project is created inside the .scribe/projects folder.

• Inside the projects folder, the project created by the user is stored.

• On the project page, the user can see three different folders:

       1. Audio Translation-Empty folder 
       2. Text Translation – Contains the USJ file the user will work on. 
       3. Sources – Contains the converted USJ file that the user uploaded (original USFM file). 
       4. Scribe.json 
  

Screen Recording

Project creation

Environment:

Tested on the electron app

Moving this issue to In progress for further development.