Tutorized

Tutorized Application is a system that allows students to schedule time with a tutor in their subject of expertise. Once the appointment has been requested by the student, the tutor accepts this appointment. Additionally, this system provides the ability for a student and the tutor to chat. This application ensures that students are getting as much help as they need in a timely, organized manner.

Getting Started

Clone (as shown below) or download this project onto your desired location.

git clone https://github.com/UWF-HMCSE-CS/SEM2018_Group5.git

Or, you can access our website by visiting: http://tutorized.azurewebsites.net/

Installing

If you chose to clone the project, once downloaded, open the project solution file (.sln) in Visual Studio or any other preferred IDE. Once the project has been loaded, you want to install the node packages before executing the program.

If you are using Microsoft's Visual Studio, you can install the node packages by:

Tools -> NuGet Packet Manager -> Package Manager Console

Once the console is displayed, type the following to ensure you install the packages inside the correct folder.

Step 1: get to the correct folder

cd .\TUTORized

Step 2: install the node packages

npm install

Running the program

After reading the description above, you must have figured out that our application is used for both students and tutors, hence the following steps (along with sample images on the bottom of each step) will be shown using both users.

Login as a Tutor

1. The first screen will have you log in, but you will need to sign up before you log in, so click on the "Sign up" button.

2. Here, it will ask you to enter your first and last name, email id, password and indicate that you are a tutor.

3. Once you are signed up, it will take you back to the log in page, where you will log in.

4. After logging in, you will see a page that will welcome you to our website!

Tutors Can Create An Available Appointment (Build Their Schedule)

1. On the left hand side, one of the menus on the navigation bar will have "Create New Appointment" where you will want to go next.

2. This will ask you to enter the subject you are tutoring in along with your available date and time, click on the submit button to release your appointment to the student.

3. Your appointment will be shown on the calendar and once a student confirms it, you will receive an Email confirmation, and your calendar will have their name on it (compare the two images below, one without the student's name which means nobody has taken up that appointment versus the one that has a name of a student which has confirmed your appointment).

Tutors Can Upgrade Students to Tutor

1. Navigate to the "Approve New Tutors" page by selecting "Approve New Tutors" from the nav menu

Currently all Tutors have the capability to upgrade a capable Student to Tutor status. In our next release there will be a verification process put into place to require an approval authority. Additionally, there will be a capability to accept requests from non-students to be vetted and approved to tutor students.

2. Next use the drop down menu to select a Student you wish to upgrade to Tutor

3. Once the correct Student is selected click "Submit" and you will recieve a notification once the upgrade is complete

Login as a Student

1. The first screen will have you log in, but you will need to sign up before you log in, so click on the "Sign up" button.

2. Here, it will ask you to enter your first and last name, email id, password and indicate that you are a student.

3. Once you are signed up, it will take you back to the log in page, where you will log in.

4. After logging in, you will see a page that will welcome you to our website!

Schedule an Appointment as a Student

1. On the left hand side, one of the menus on the navigation bar will say "Schedule An Appointment", that is where you will want to go next.

2. This dropbox box will show you a list of available tutor appointments, select an appointment and then click on the submit button to confirm your appointment.

3. Once you confirm it, you will get be alerted saying "Scheduled Successfully".

4. The appointment you just confirmed will be displayed on your calendar along with the date, time and the name of your tutor.

Using the Search Bar on the Schedule An Appointment Page

1. If you wish to search an appointment you can type either the Tutors name or the Subject you wish to filter by, and click "Apply Filter" and you will get a notification that the Appointments were filtered successfully.

2. Next, use the drop down box; you will notice that it is now filtered. Select the Appointment you wish to schedule, and finish the appointment scheduling process as described above.

3. If, after you have applied a filter, you wish to reset it and filter for a different Tutor or Subject; simply click the "Reset Filter" button. At this point you can start over from step one and start your search again, or simply use the drop down menu and select from the entire list of Appointments.

Viewing Users (Tutors or Students) you have worked with

1. After you have logged in (discribed above), select the correct tab based on what "Role" you are logged in under.

A) Logged in as "Tutor"

B) Logged in as "Student"

2. Next you will be able to see who you have worked with, or if you have not worked with anyone yet.

A) Displays the Users you have worked with

B) Informs you that you have not worked with another User yet

Messaging a User (Tutors or Students) you have worked with

1. After you have logged in (described above), select the 'Messages' tab to chat with a user you have worked with. If you are a tutor, you can only chat with students you have worked with. If you are a student, you can only chat with tutors you have worked with.

Logged in as a "Tutor" or a "Student"

1. Select a user, type your message and click on the send button. That message will appear under 'List of your sent messages:' You can view their messages by looking at the 'List of your received messages'.

Sharing a Resource with a Student/Tutor you have worked with

After you have logged in (described above), select the 'Resources' tab to share a resource with a user you have worked with. If you are a tutor, you can only share with students you have worked with. If you are a student, you can only share with tutors you have worked with.

Currently a student or a tutor can only select the file to be uploaded. In our next release there will be a capability to select a user and send that file that you selected to upload. Additionally, you will be able to look at the files sent from you and sent to you.

Logged in as a "Tutor" or a "Student"

1. Select the Resources tab

2. And you should see a page similar to this.

3. Click "browse" to select a file, once selected the name of the file will show up to ensure you have got the correct file.

4. Once you're done, click on upload to send it and you should get a message saying the upload was successful.

Running the tests

You can run the tests by going to the 'Test' menu, then 'Run' and 'All Tests', an image is provided below:

Built with

• Vuetify - A componenet framework for Vue.js
• Dapper - An ORM mapping framework

Authors

Wesley Easton

Timothy McWatters

Keenal Shah

Wenwen Xu