Welcome to the documentation pages of the InstantWords of openCX!
You can find here detailed about the (sub)product, hereby mentioned as module, from a high-level vision to low-level implementation decisions, a kind of Software Development Report (see template), organized by discipline (as of RUP):
- Business modeling
- Requirements
- Architecture and Design
- Implementation
- Test
- Configuration and change management
- Project management
So far, contributions are exclusively made by the initial team, but we hope to open them to the community, in all areas and topics: requirements, technologies, development, experimentation, testing, etc.
Please contact us!
Thank you!
Daniel Garcia Silva up201806524@fe.up.pt
Gonçalo Alves up201806451@fe.up.pt
Inês Silva up201806385@fe.up.pt
Pedro Seixas up201806227@fe.up.pt
José Silva up201705591@fe.up.pt
Enabling everyone, specially people with hearing disabilities, to experience conferences to the fullest by using speech-to-text to create real time subtitles during talks!
Conferences are great way of sharing knowledge, sadly not everyone can enjoy them equally. Hearing problems and the language barrier are a major turndown for lots of users. As most of the organized conferences don't have the access to a captioner, we created InstantWords. Our app makes use of Speech-To-Text technology, providing transcripts directly to your phone, in a wide array of languages, and enabling a brand new audience to enjoy their favourite conferences.
-
Actor: User.
-
Description: The User can register in the app.
-
Preconditions and Postconditions: For Register, there are none. For Login, must have a previously registered account.
-
Normal Flow: i. The user registers in the app by choosing a username, email and a password.
-
Alternative Flows and Exceptions: When registering, if the password is considered weak (has less than 8 characters), a pop-up message will alert the user of this event and block him from creating an account with those credentials. When logging in, if the user tries to login with invalid credentials, wether it be the username or the password, a pop up message, similar to that described above, is displayed alerting of this event.
-
Actor: User.
-
Description: The User can view the list of conferences.
-
Preconditions and Postconditions: The User must be registered within the app.
-
Normal Flow: i. The User, after logging in/registering enters the dashboard and can view a list of conferences.
-
Alternative Flows and Exceptions: ia.The User can go to his profile, by clicking his profile picture, and can view his attended and created conferences. ib. The User can use the search bar, in the dashboard, to filter the list of conferences.
-
Actor: Speaker.
-
Description: The Speaker can add a conference, by choosing his speech language.
-
Preconditions and Postconditions: The User must be registered within the app.
-
Normal Flow: i. The Speaker, after logging in/registering enters the dashboard and has an option to add a conference. ii. A new window will appear requesting the conference's name and speech language.
-
Alternative Flows and Exceptions: If the Speaker tries to create a conference with a name that already exists or with no language, a pop up message will appear, alerting the user to this event and blocking him from doing so.
-
Actor: Speaker.
-
Description: The Speaker can view the transcript of his speech.
-
Preconditions and Postconditions: The Speaker must be registered within the app and have created a conference.
-
Normal Flow: i. The Speaker, after creating a conference goes to a new window where he can speak, by clicking in the microphone button. ii. After speaking a few words, the Speaker can see the transcript of his speech in the screen.
-
Alternative Flows and Exceptions: ia. The Speaker, when in his profile page, can click on one of his created conferences, sending him to the conference window described above.
-
Actor: Spectator.
-
Description: The Spectator can view the transcript of a speech, in a language of his choosing.
-
Preconditions and Postconditions: The Spectator must be registered within the app and must have chosen a conference to attend.
-
Normal Flow: i. The Spectator, after selecting a conference to attend in his dashboard, goes to a new window where he can choose the language of the transcript, from a dropdown list. ii. After choosing a language, the Spectator can see the transcript of the speech in the screen, translated in that language.
-
Alternative Flows and Exceptions: ia. The Spectator, when in his profile page, can click on one of his attended conferences, sending him to the conference window described above.
As a spectator, I want a transcript, so that I can read what is being said in the conference.
Mockup
Acceptance Tests
Given I want the transcript of the current talk,
When I select it on the app,
Then I can read what is being said.Value: Must have
Effort: XL
As a spectator, I want to attend conferences in any language, so that I have more options to attend.
Mockup
Acceptance Tests
Given I want to understand what is being said,
When I attend a conference in any language,
Then I have more options of conferences to attend.Value: Must have
Effort: M
As a spectator, I want to select the transcript language, so that I can read what is being said in my desired language.
Mockup
Acceptance Tests
Given I want to select the transcript language,
When I attend a conference,
Then I can read what is being said in my desired language.Value: Must have
Effort: XL
As a speaker, I want to be able to select my speech language.
Mockup
Acceptance Tests
Given I want to be able to select my language,
When I start the conference,
Then the spectators know which language I am speaking.Value: Must have
Effort: M
As an user, I want to be able to create my own account, so that I can use the app.
Mockup
Acceptance Tests
Given I want to be able to create my own account,
When I use the app,
Then I can save my preferences.Value: Should have Effort: M
As a spectator, I want to be able to search for talks/conferences, in order to join them.
Mockup
Acceptance Tests
Given I want to search for talks/conferences,
When I´m using the app
Then I can join the talks/conferences.Value: Could have
Effort: S
As a specator, I want to be able to scan a talk/workshop QR code, so that I can join it directly.
Mockup
Acceptance Tests
Given I want to be able to scan a talk/worlshop QR code,
When I'm attending one,
Then I can join it directly.Value: Should have
Effort: L
As an user, I want to track which conferences I attended and planned to attend, so that I can organize my schedule.
Mockup
Acceptance Tests
Given I want to track which conferences I attended and plan to attend,
When I'm using the app,
Then I can organize my schedule.Value: Could have
Effort: M
As an user, I want to be able to logout, so that I can share my device with other people.
Mockup
Acceptance Tests
Given I want to be able to logout,
When I'm logged in the app,
Then I can share my device with other people.Value: Should have
Effort: S
As a speaker, I want to be able to create a talk, so that spectators can join.
Mockup
Acceptance Tests
Given I want to be able to create a talk,
When I'm speaking at a conference,
Then Spectators can join my session and read the transcript.Value: Should have
Effort: M
As an user, I want to be able to login, so that I can attend conferences.
Mockup
Acceptance Tests
Given I want to join/create conferences,
When I fill with valid credentials,
Then I should be redirected to the conference dashboard.Given I want to join/create conferences,
When I fill with invalid credentials,
Then I should be prompted an error.Value: Must have Effort: S
Description: All users have one single profile. A user can be a Speaker or an Attendee depending on the situation. A conference can be attended by several Attendees and can only have one Speaker.
To structure our app we used a package diagram:
- Search package contains the components to create or join a conference and depends on our conference package and an external package (QRCode);
- Conference package contains the components to get a transcript, choose a language and speak. It also depends on two external packages (SpeechToText and Translation).
- Account Package contains the components to get a user's conference record and created conferences;
- Authentication package contains the components to login, register and logout a user;
For our application, we will be using Flutter, for the framework, and Firebase, for the database. We are also using some API's for our Speech to Text, Translation and QR Code generation functionalities.
To test our apllication we implemented Acceptance and Unit tests. Acceptance Tests are used to verify the expected output through statements that describe all of the actions the user must take to permform a task, and the result of those actions. Unit Tests are used to verify the expected output after the user interacts with the application.
Unit Tests were with flutter_test, while Acceptance Tests were done using flutter_drive.
Since our app heavily depends on FireBase, Speech-To-Text and Translation - which are provided by Google - Unit Testing mainly focused on the default and expected widget output.
Implemented acceptance tests:
-
Invalid Login:
- We simulate a press in the login button, without any information inputed in the apropriate e-mail and password fields;
- Then, we check if the app displays a message of 'Login failed';
-
Valid Login:
- We simulate the input of valid credentials into the apropriate e-mail and password fields;
- The, we simulate a press in the login button;
- Finally, we verify if the login was successful by searching for a specific text, located in the dasboard screen;
Implemented Unit Tests:
- Valid Start Screen:
- We check if the app starts of in our login page, with all inputs empty;
- Valid Dashboard:
- Pressing on the "Dashboard" button it must go to the dashboard
- Valid Search:
- Pressing on the "Search" button it must go to the search page
- Valid Create Conference page:
- Pessing the "Create" button it must go to the "Create Conference" page
Funtional Tests:
-
Speaker
- The user inputs the email 'teste@gmail.com' and the password '1234567890' and clicks the login button
- The dashboard is shown
- The user clicks the 'Create' button
- The user inputs 'TestConference' in the conference name and 'English (United States)' in the language (the one he will be talking in the conference)
- The conference with name 'TestConference' and language 'EN-US' is inserted into the database
- The conference speaker page is shown
- The speaker clicks the 'QR' button
- The QR code is shown to be scanned by the attendees
- The speaker clicks the 'Start Speaking' button
- Speaker says 'Welcome to Test Conference'
- The speaker clicks the 'Stop' button to stop speaking
-
Attendee
- The user inputs the email 'teste2@gmail.com' and the password '1234567890' and clicks the login button
- The dashboard is shown
- The user joins the conference 'TestConference'
- Using QR code
- The user clicks the 'QR' button in the main page
- The user scans the QR code shown by the speaker
- Using the search bar
- The user clicks the 'Search' button in the main page
- The user inputs 'Test' in the search bar
- The conference 'TestConference' is shown in the results
- The user clicks the conference 'TestConference'
- Using QR code
- The conference page is shown
- The attendee chooses 'English (United States)' as language
- The text 'Welcome to Test Conference' is shown
- The attendee chooses 'Portuguese (Portugal)' as language
- The text 'Bem-vindos à conferência de teste' is shown
There are still some cases to be tested and improvements for the future. They are the following:
- Testing whether the QR code is correctly interpreted
- Create accounts without populating the database
- Decouple the need of Firebase(via mocking) to allow the existance of more Unit Tests
Describe your contribution to open-cx (iteration 5), linking to the appropriate pull requests, issues, documentation.