Skip to content

User Guide

Elie-Elia edited this page Nov 18, 2019 · 10 revisions

The following user guide provides a detailed overview of how to use the TutorMe Application. Frontend deployment URL in order to view the application can be found here

The following Login credentials are provided for testing purposes:

Login credentials:

Login:

The above screenshot shows our landing page. From there, the manager can choose to either login if they already have an account, or to sign up otherwise. Clicking sign in redirects the user to the homepage, sign up sends them to the registration page.

Registration:

The above screenshot shows our registration page for users who do not have an account. To create an account, they enter their registration information and click on register. All fields are required, the email address needs to follow a standard email format (i.e [email protected]) and there are no restrictions on the password format.

HomePage:

The above screenshot shows our HomePage, which the user is redirected to after logging into our application. On the Homepage, the Manager is able to view a scheduler of all lessons currently taking place at the TutorMe Center, where lessons can only take place between 9am-9pm and on weekdays.

Lesson:

The above screenshot shows the 'View Lessons' page, which lists all the current lessons taking place at the TutorMe Center. Each lesson has a date, and a starting-ending time. Each lesson can also be updated or deleted by clicking on the respective text hyperlink or delete button. If there are more than seven students attending a lesson, this is considered a group/review session which is listed in the Group Lessons section. The manager can then update lessons within this section to assign large enough rooms for the lesson to take place.

Create Lesson:

The above screenshot shows the 'Create/Update Lesson' page which provides input fields to either create or update a lesson. A lesson can be assigned a course, room, starting time and ending time through the field's calendar integration, multiple students and tutors.

Courses:

The above screenshot shows the 'View Courses' page which lists all courses at the TutorMe Center. The courses are displayed according to a parent categorization of subjects. A 'Create Subject' button allows the user to create new categorizations of courses, and within each subject a user can create/update/delete courses by clicking on the respective buttons or hyperlinks.

Create Subject:

The above screenshot shows the 'Create/Update Subject' page which provides input fields to either create/update a subject according to a selected associated university and the subject's name.

Create Course:

The above screenshot shows the 'Create/Update Course' page which provides the input fields to either create/update a course within a subject by choosing the associated subject and inputting the course name.

Universities:

The above screenshot shows the 'View Universities' page which lists all the registered Universities for the TutorMe application. From this page, a university may be created/updated/deleted according to the respective buttons or hyperlinks.

Create University:

The above screenshot shows the 'Create/Update University' page which provides the input fields to either create/update a university with a name and a list of subjects to add to the selected university.

Room:

The above screenshot lists all the rooms that are at the TutorMe Center. The manager can create a room if a new room has been added to the center. The manager may also update a room if there are any sizing changes that need to be made or delete a room if it has been removed from the center.

Create Room:

The above screenshot shows the 'Create/Update Room' page which provides the input fields to either create/update a room with the number of seats within the room and its size.

Student:

The above screenshot displays the list of Students currently registered at the center. The manager can view the students' email, review comments, and toggle the visibility of the reviews given to students. The manager can also remove students from the Center by clicking the 'Remove Student' button.

Tutor:

The above screenshot displays the list of Tutors currently registered at the center. The manager can view the tutors' email, hourly pay-rate, review rating according to reviews written by students and review comments, approved courses that the tutor can teach, and courses the tutor has applied to teach. The manager can then approve or deny courses that the tutor has requested to teach. The manager can toggle the visibility of the reviews and can fire tutors from the Center by clicking on the 'Fire Tutor' button. Lastly, the manager can view their commission on the tutor's hourly wage through the integrated payment partner 'Paypal' that is linked at the top of the Tutor page.