TUTORVERSE

WEBSITE FOR ONLINE TUTORING

Final Release Document

– Ho Chi MInh, Jul 2024 –

Table of Contents
I. Deliverable Package............................................................................................................................3
II. Installation Guides.............................................................................................................................3
III. User Manual......................................................................................................................................3
1. Overview........................................................................................................................................3
2. <<Workflow Name 1>>..................................................................................................................3
2. <<Workflow Name 2>>..................................................................................................................3
I. Deliverable Package

No. File Notes

1 G4-TutorVerseDB_DB_.sql Database, including both table structures and table
data
2 G4-TutorVerse _SRS_final.docx Final SRS (Requirement) Document
3 G4-TutorVerse _SDS_final.docx Final SDS (Design) Document
4 .env File contains the individual user environment variables
use in the source code

Other related deliverables:

 Front end source codes: https://github.com/khoaKoGioi/PrjSWP-rentingTutorWeb.git
 Back end source codes: https://github.com/Baoaxid/serverTutor.git

II. Installation Guides

The website will be running on a local host 5173 with the Microsoft SQL Server for database hosting.
Both the source codes of backend and frontend will running on Visual Studio Code.

1) Database installation
- To create the database for the website, open the Microsoft SQL Server and run the following
queries provide by the G4-TutorVerseDB.sql.
 - After successfully create the TutorVerseDB database, configure the local maching SQL
manager to ensure the database will be working whenever the website is running.

2) Front end installation

- On the front end side, create a folder on a desired location of the computer to store the
frontend code.
- Open the Visual Studio Code, choose the newly created folder and open the terminal
command. In the terminal, use the command : ” git clone
https://github.com/khoaKoGioi/PrjSWP-rentingTutorWeb.git” to start download the front
end source code
- Change into the project directory by using the command:” cd PrjSWP-rentingTutorWeb”

- Continue download all the dependencies of the program by using the command:”
npm install”

- Ensure to add the .env file to the root of the project, this will provide the necessary
environment variables use in the source code
- To start the front end side of the web, use the command:” npm run dev” to run the website.

- Go to the http://localhost:5173/ on any browser to enter the webpage.

3) Back end installation
- On the Back end side, create a folder on a desired location of the computer to store the
frontend code.
- Open the Visual Studio Code, choose the newly created folder and open the terminal
command. In the terminal, use the command : ” git clone
https://github.com/Baoaxid/serverTutor.git” to start download the back end source code.

- Change into the project directory by using the command:” cd serverTutor”

- Continue download all the dependencies of the program by using the command:”
npm install”.
 - Ensure to add the .env file to the root of the project, this will provide the necessary
environment variables use in the source code
- To start the back end side of the web, use the command:” npm run dev” to run the server of
the website.

- When success, the terminal should display two messages indicate that both the database is
connected and the server will be running on port 5000

NOTICE: In order for the website working as intended, the back end has to ensure connection with the
database. Both back end and the front end program has to be run as the same time with the port
they are assigned with.

III. User Manual

1. Overview
The TUTORVERSE website provide many usefull features and tools to help both student and the tutor
for a seamless experience in education environment. Guest users can have limited access to the web
while student who has registered to the website can:

 Search for tutors by name or subject.

 View tutor profiles and their credentials.
 Chat with tutors to discuss their needs.
 Rent a tutor for a specified number of hours.
 Leave ratings and feedback for tutors after the rental period.

Tutor user who are individuals, primarily graduates, who offer tutoring services through features
provided by the website:
  Create and manage their tutoring services.
 Specify their subjects of expertise.
 Set hourly rates for their services.
 Upload academic videos to advertise their services.
 Manage bookings and communicate with students.
 Maintain and update their profiles, showcasing their educational qualifications, specialized
skills, and personal identification information.

The admin of the website can also moderate the content on the website and resolve complaint from
the user. They can also have the option to check the revenue of the web and the current users

2. Registration and login to the website

In this workflow the user will be able to create a account base on their needs and role in order to
access the feature provided by the website.

- The website will allow the user to create student account or a tutor account base on their
need.
- For students they can create a account with an available email, the website also require the
student to provide detail information like school and grade for credential.

- After create an account the student will be redirect to homepage

- Whenever enter the page the student can you the registered email and password to login to
the web

- As for tutor user, the process of creating an account will be monitor through admin. The
tutor will need to provide a degree, identity card to check for authentication, these will be
check by the admin.
- After create a tutor account, a message will appear to alert the user that the account has
created successfully. The admin can now view this tutor profile before approve the tutor
account to use the website.

- On admin page, the Tutor who recently create an account will be shown in a list, by checking
the profile of the tutor they will decide to accept the tutor account or decline it.
- If accepted the tutor can now access the account through their regisetered email and
password.
3. Class Enrollment
- Student can search for class on search bar choose the class taught by other tutor, after that
the student can choose to enroll the class they want.

- When successfully enroll to the class, the student can get in touch with the tutor and give
feedback for them after lesson
- The students can communicate with their tutors through the chat box feature, all the tutors
who student study with will appear in their chatbox.

- After enrollment, the student can leave feedback and rating for the tutor base on their
experience.
 - When the student has finish the class, the tutor can unenroll the student to take in new
student.

3. Create new class

- Every tutors on the web can create a class they want to teach by go to the manage class
button and start create a new class.

- The tutor will require to fill detail about the class they want to teach, as well as a promotion
video for their class.
- In order to add their class to the website, tutor will require to pay a one time subscription to
create their class.
 - After the payment has been confirm the class will be add on the web. If the tutor need to
change any information about the class, they can update it or deactivate their classes.

4. Sending a complaint
- Any user can make a complaint about the web to the admin so they can help improve the
website.
 - The admin can read the complaint from the user. After resolve the issue, they can delete the
complaint message.

5. Managing website
- The admin has many tools to overlook the website. They can check active users on the
website and ban them for inappropriate activities.
- Admin can check for any active class on the website and look at their details.

- Admin can approve tutor account if there is any tutor register on the website.
- Admin can check for any active class on the website and look at their details.

- Through revenue manager, the admin can check for the number of active users on the
website and the overall revenue on the web.