Skip to content

Releases: Techie09/readr

Readr Early Preview

17 May 17:19
@Techie09 Techie09
0.0.1.0alpha
8316b3f
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
Readr Early Preview Pre-release
Pre-release

Current Functionality

👤 User Account Management

  • Create User Accounts
  • User login

📚 User Session Management

  • Start session with ISBN (10 or 13 digits)
  • Start session without ISBN (description)

👓 Readr Session Features

  • use Ctrl + F2 to take a screenshot,
  • use search feature to search results from screenshots

📔 Notes:

✔️ comes with 1 pre-built sample text.
⚠️ MongoDB instance is required for setup
⚠️ An Azure API Key is required for setup.

🧪 Test Plan v0.0.1.0alpha:

Below are the cumulative Tests that should be performed before each release. There are some notes regarding to the current state of the project.

⚠️ Add A User

Description:

  • On the Login Screen, the user shall be able to create a username.

Restrictions:

  • The username must be unique and is Case-sensitive.

Error Handling:

  • If a username is already in use, an error message shall occur.
  • If communication fails with the server, an error message shall occur.

Results:
✔️ Pass - can create a new username; message appears to verify account has been created
⚠️ Unknown - did not test Case-sensitive scenarios
✔️ Pass - cannot create duplicate usernames; message appears to warn user that username already exists
✔️ Pass - if there is a communication failure, a message appears with error

✔️ User Login **Description:** - On the Login Screen, the user shall be able to login with a username.

Restrictions:

  • The username must already exist.

Error Handling:

  • If a username does not exist, an error message shall appear.
  • If communication fails with the server, an error message shall appear.

Results:
✔️ Pass - user with existing username can login
✔️ Pass - user with new username receives error message that the username does not exist
✔️ Pass - if there is a communication failure, a message appears with error

✔️ Change Server Address **Description:** - On the Login Screen, the user shall be able to change the server address

Restrictions:

Error Handling:

  • There is no error checking for the API, maybe this will be an issue in the future to resolve.

Results:
✔️ Pass - Default server address used is http://localhost:5000
✔️ Pass - Defining a server address will update the api calls to use custom server address

❌ Create User Session with ISBN **Description:** - After Login, the user can enter an ISBN to start a Readr session. - Optionally, the user can also add a description.

Restrictions:

  • ISBN must be 10 or 13 digits in length.
  • The ISBN can contain hyphens, but will be ignored.
  • The ISBN can begin or end with whitespace, but will be ignored.

Error Handling:

  • If an ISBN contains characters other than numbers, hyphens, or whitespace -- an error message shall appear.

Results:
✔️ Pass - ISBN containing 10 digits is saved successfully
✔️ Pass - ISBN containing 13 digits is saved successfully
✔️ Pass - ISBN can contain hyphens is saved successfully
✔️ Pass - ISBN and Description entered is saved successfully
✔️ Pass - ISBN with whitespace at the end is saved successfully
❌ Fail - ISBN with alphanumerics is invalid; a message appears with error

entered 'abc1234567' and the session started without throwing the error

✔️ Create User Session with Description **Description:** - After Login, the user can enter a description to start a Readr session. - Optionally, the user can also add an ISBN.

Restrictions:

  • None.

Error Handling:

  • None.

Results:
✔️ Pass - Description is saved successfully

✔️ Session Duration **Description:** - During a session, the user shall be able to view the current duration of the session

Restrictions:

  • None.

Error Handling:

  • None.

Results:
✔️ Pass - When the user beings a session, the duration timer appears and is updating correctly.

❌ Take a Screenshot **Description:** - During a session, the user can take a screenshot using [Ctrl + F2] - On Success: The Confidence Indicator shall turn Green for 5 seconds before Idling(Gray)

Restrictions:

  • None.

Error Handling:

  • If an error occurs, the Confidence Indicator shall turn Red for 5 seconds before Idling(Gray)

Results:
✔️ Pass - user can press [Ctrl + F2] and capture a screenshot; The Confidence Indicator displays Green for 5 seconds before turning Gray
❌ Fail - user can take more than one screenshot; The Confidence Indicator displays Green for 5 seconds before turning Gray

I believe the screenshot is captured, but the Confidence Indicator remains Gray and never changes.

✔️ Search Captured Text **Description:** - The user shall be able to enter a word (or part of a word) and receive results - The results shall contain: -- display the line of words the word was found within -- an approximate line number the word was found within. -- an approximate position the start of the word within the line the word was found within.

Restrictions:

  • None explicitly defined.

Error Handling:

  • None explicitly defined.

Results:
✔️ Pass - The User can enter part or entire word to search and receive results
✔️ Pass - multiple results return with well defined UI
✔️ Pass - results return with the line of text the word is found within
✔️ Pass - results return the approximate line number each result was found
✔️ Pass - results return the approximate position of the word found in each result

Assets 4