Before continuing with this User Guide, please follow the steps outlined in the deployment guide.
| Index | Description |
|---|---|
| Authentication Page | Logging in and signing up |
| Admin View | Demonstrates functionalities when logged in as an Admin |
| Instructor View | Demonstrates functionalities when logged in as an Instructor |
| Student View | Demonstrates functionalities when logged in as a Student |
Signup Screen
The first user who signs up is granted "Admin" privileges. Subsequent users are registered as "Students" to ensure they have the lowest permissions.
Once the user has signed up, they must enter the verification code sent to the registered email.
Login Screen
After successfully signing up and verifying their email, the user can login using their credentials.
Courses Screen
Upon signing in with an "Admin" account, the admin can view all the courses offered at the institution.
Clicking on the button in the "Action" column allows the user to edit the selected course.
Clicking on the "Plus" button at the top right corner allows the user to create a new course, and assign an instructor to teach it.
Institution Users Screen
After clicking on the "Users" tab on the side navigation bar, the admin can see all of the users that are part of the institution.
The admin can change the role of a user by clicking on the button at the end of the user row and selecting a new role. Users who are initally signed up as students but should be instructors or admins can have their roles elevated here.
Institution Settings Screen
After clicking on the "Settings" tab on the side navigation bar, the admin can see the institution configuration. This configuration is what all of the users of the application sees on their side navigation bar after logging in.
To change the configuration, the admin can upload a new logo and change the colour of the side navigation bar. After clicking "Save Changes", these new settings will be visible to all users of the application.
Courses Screen
Upon signing in with an "Instructor" account, the instructor can view the courses they are teaching.
Clicking on the "Add Course" button allows the user to create a new course.
Upload Screen
After clicking on the upload button for a given course, the user can upload course specific documents which will form the knowledge base of the chat bot.
Enrolled Students Screen
After clicking on the invite button for a given course, the user can view the list of students enrolled in the course.
Clicking on the "Invite Users" button allows the instructor to copy an access code which should be distributed to the students of the course.
Report Screen
After clicking on the reports tab on the side navigation bar, the instructor can view reported conversations and make changes to the course documents accordingly.
Courses Screen
Upon signing in with a "Student" account, the student can view the courses they are enrolled in.
The user can click on "Join Course" and provide the access code to a course sent by an instructor.
Chat Screen
After clicking on the chat button from the courses screen, the student can ask course specific questions to the chat interface. The response returns the source where the information was found.
If the response is not what the student was expecting, they can report the conversation by clicking on the octagon button located at the lower right corner.
