Skip to content

User Documentation

Kyle Zhou edited this page Dec 15, 2024 · 1 revision

User Documentation

Installation Instructions

  • The device we used for development in Android Studio: Pixel 9 API 35

  • We also used a physical Samsung Galaxy s9 throughout testing & development

  • The project is completely buildable from our main branch on GitLab and we also have a runnable APK as well

  • If running from main:

    • Go to Tools -> Device Manager -> navigate to the new side window.
    • Click + -> Create Virtual Devic
    • Search for "Pixel 9" -> select Pixel 9 -> click Next
    • Choose the VanillaIceCream system image -> click Next -> Finish
    • Go to File -> Sync Project with Gradle Files. This may take a while, ensure the files have been synced before continuing to the next step.
    • Click the run button. This runs the image in the Pixel 9 emulator.
  • If running APK:

    • Ensure the emulator is set up as mentioned above and start the pixel 9 simulator
    • Drag and drop the APK into the simulator screen

Usage Guidelines

Currently, Echo Note has the following key pages/features that enable users to record and store summaries of audio memos. Users can apply this functionality to tasks like writing notes for a lecture, summarizing the key points of a doctor's visit, or any other time a user may want to track/summarize an audio message.

Login, Signup

The login and signup screens ensure the user has filled all mandatory fields, that the email provided is a valid format, that the password is long enough, and that the correct credentials are entered.

Signin Signup Signup Error Error

Home Page

Upon signing up with a new user or logging in with an existing profile, the user is brought to the home screen. The home screen displays the current folders that belong to the user. Each folder can be toggled to also display the items belonging to each folder. From this page, a user can:

  • Create a new folder
  • Rename folders, notes, descriptions
  • Delete folders, notes
  • Move notes between folders
home new_folder item itemMove

Viewing Existing Notes

From the home page, a user can click on a note. This brings the user to a new page where they can view the contents of their note.

itemView itemOption

Adding a New Note

A user can create a new note by clicking on the + button in the bottom navigation bar. This takes the user to a new page where a user can choose to record new audio, upload an existing recording, or manually enter text. After the audio is transcribed, the user can verify the text has been recorded correctly and then submit the transcription to be summarized. Finally, the user can choose to save the summary and name it accordingly.

record text summarize

Clone this wiki locally