peer-tutoring-app

Peer tutoring app to match tutors with tutees. This was built on the MERN stack, and uses SendGrid to manage automated emails from the service. To deploy for your own purposes, you can use the one-click deploy to heroku button below:

To change the emails that are sent, edit the files found in the /assets/email/ directory.

To change the logo of the application, place svgs in /client/src/assets/images/logo/. Make sure to follow the same formatting, and to supply both grey-scale and color versions of the logos.

To change the favicon of the application, place your new favicon in /client/public/.

Development

All API work is done in the root-level directory. All frontend work is done in the /client directory. API work is written in Javascript, while the Frontend is written in Typescript.

General Features

This application handles everything that you would expect a web app to have: login / logout, forgot / reset password, change password, confirm email address, etc. The API has many endpoints that are also secured.

Tutor Features

Edit Tutor Information

Tutors must state which course they can provide instruction for, which can be found after clicking the Account button.

Tutor Home Page

The home page contains the questions that the tutor is currently answering, as well as all of the questions that they answered in the past:

When a student asks a new question for a course the tutor can instruct, they will be notified via a little notification icon:

A GIF of what should happen:

After getting a new question, tutors should find the student in the physical space, and then start the session by clicking the Start button. If they cannot find the student, then they can choose to resolve or yield the question.

"Start", "Yield", and "Resolve"

• Starting a question means that you have found the student, and are actively providing instruction.

• Yielding a question places it back at the start of the queue, and prevents the given tutor from receiving that question again. This action might be triggered for a few reasons:

  1. The tutor does not feel comfortable interacting with a given student.
  2. The tutor does not know how to answer this question.

• Resolving a question removes the question from the queue, and ends the session. This action might be triggered for a few reasons:

  1. The student has an answer to their question.
  2. The student wants to be removed from the queue.
  3. The student was no longer in the room when the tutor was assigned.

Student Features

In order to ask a question, students must first sign up and then confirm their email address. Afterwards, they will be brought to the Home page, where they will be able to view their current question, and their past questions.

Student Home Page

Asking New Questions

To prevent spamming, students can only ask one question at a time. In order to ask a question, the student can click the Ask New Question button. On clicking, they will be navigated to the following page, where they can provide pertinent information:

Once they've asked a new question, they will be placed in the queue. Information about queue position, etc. is found on their question card:

Staff Features

Stats View

View stats on the stats page. There is a lot of information available:

Invite Users

Staff members can invite users via the invite page. Upload by csv, with the format: email,accountType. Otherwise, add invites manually.

Desktop Notifications

If the user allows desktop notifications, they will be notified via the desktop notification. Otherwise, there are in-browser notifications.