Skip to content

barrybecker4/TutorMatch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Logan TutorMatch

A tutor matching web application. The purpose is to automate the process of matching students who need tutoring with those willing to tutor. The work was done in collaboration with the students of James Logan High School's Computer Science Club, but the application should be appropriate for use by any learning institution.

The application has 3 primary components

  • Landing page - which directs you to fill out a tutor profile form, or a tutoring request.
  • Tutor profile form - a Google form which writes to a TutorProfiles spreadsheet.
  • Tutoring request page - a dynamically generated form for creating a request for tutoring.

When a student sees the page that allows them to request tutoring, they first select a subject. Next they select a course for that subject. Finally they select a tutor that is available to tutor for that course. More options may be added in the future (like language, time, and place). The items listed in each successive selection is determined by the one before it. The submit button is enabled only when valid selections have been made.

When the submit button is clicked, an email is sent to the following people.

  • To the requester to let them know that their request has been made, and provide a link to a feedback form.
  • To the tutor requested to let them know to make tutoring arrangements with requester, and also provide a link to a progress form that can be filled out to track tutoring progress over time.
  • To administrator(s) to notify of the new pairing and to review it.
  • Optionally, to the teacher who's course it is. The configuration can specify teachers that should be emailed for specific courses.

A configuration spreadsheet is specified that provides the resources (such as forms, spreadsheets, and emails) to use when deployed.

How to Run and Contribute

This is a Google App Script (GAS) application. If you would like to contribute, first install CLASP. Next git clone this repository somewhere on your local machine. Then, from the LoganTutorMatchApp directory within the cloned project directory, run the following commands:

  • clasp login      (using gmail account)
  • clasp create --type webapp   (this creates a script with this name in your Google Drive)
  • clasp push     (push all the files in the project directory into that script in the cloud)

Now you are good to go. Deploy the web-app from your script on Google Drive. Make changes locally (in intelliJ for example), do "clasp push", and refresh the deployed app script page to see the change. Do git commit, push, and create pull requests through Github when you have a feature or fix to contribute.

The very first time you need to run, set the id of the configuration spreadsheet in config.js (see comment there).

This application has been full internationalized and localized to 3 languages (English, Spanish, Chinese). More languages can be added by editing this sheet of messages.

About

A tutor matching web application. I am working with students at James Logan High School to develop it.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published