Skip to content

Commit

Permalink
Adding User Story 7 instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
jullia andrei committed Oct 11, 2024
1 parent 987c488 commit 398e10a
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 12 deletions.
32 changes: 20 additions & 12 deletions UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,22 @@

## Table of Contents
1. [User Story 2](#user-story-2)
2.

2. [User Story 7](#user-story-7)

## User Story 2
As a student, I want to receive an immediate notification when a course faculty member replies to my post, so that I can review their response within 24 hours.

### Feature Overview
* Real-time notifications:
* Push notifications that will appear on the notification side bar and on the main notification page when a course faculty replies to your post.
<img src="user_guide_images/ins_notif_1.png" alt="Screenshot 1" width="300"/>
<img src="user_guide_images/ins_notif_1.png" alt="Screenshot 1" width="500"/>
<img src="user_guide_images/ins_notif_2.png" alt="Screenshot 2" width="300"/>

* These notifications are delivered separately from non-faculty reply notifications and are indicated with the "[COURSE-FACULTY]" on the title. (As shown in the above images.)


* User Preferences: Like other notifications, users are able to customize their notification settings (choose between push, email, both, or turn both off) in the account settings page.
<img src="user_guide_images/ins_notif_3.png" alt="Screenshot 3" width="300"/>
<img src="user_guide_images/ins_notif_3.png" alt="Screenshot 3" width="500"/>

### How To Use and Test User Story 2 Feature
1. Register 2 accounts: an admin and a non-admin (student).
Expand All @@ -32,7 +31,7 @@ As a student, I want to receive an immediate notification when a course faculty

**Note: For this feature we assume that every admin account is a course faculty.**

### Automated Tests - located in *test/notifications.js*
### Automated Tests - located in `test/notifications.js`
#### Test Cases: Lines 392 - 585
* Lines 442 - 448: Testing basic functionality: user should receive a notification when a course faculty replies.
* Lines 450 - 485: Test that user should not receive notification when regular user replies.
Expand All @@ -43,22 +42,31 @@ As a student, I want to receive an immediate notification when a course faculty
#### Test Justification
We believe that these tests are sufficient as it tests the basic functionality of this new feature. The tests ensure that users receive notifications from faculty, can differentiate between faculty and regular user replies, and can manage notifications (e.g., marking them as read or adjusting settings). This ensures both the functionality and user control of the feature, making the system reliable.

## User Story 7
As a student, I want to save posts to favorites for posts that contains important information/good solutions, so that I can review them later on quickly

## User Story


### Feature Overview
* Adding a Favorites category in the discussion post bar:
* Users are able to select posts as a Favorite
* Conceptually, posts marked as Favorites could be sorted and displayed to user
<img src="user_guide_images/fav_btn_1.png" alt="Screenshot 4" width="500"/>
<img src="user_guide_images/fav_btn_2.png" alt="Screenshot 5" width="500"/>

### How to Use and Test User Story
1. User needs to register; does not have to be an admin
2. Go to "General Discussion" page
3. There should be at least one topic within the discussion page. If there are none, make a test post.
4. You should be able to see a Star button signifying Favorite
5. There should also be a Favorite button in the post bar
6. The Favorite button in post bar can be toggled on and off.


### Automated tests are located in (WRITE FILE NAME HERE)
### Automated tests are located in `test/topics/favorite.js`

#### Error Tests: Testing invalid inputs
* Test for invalid input

#### Valid Tests

#### Test Justification
We believe that these tests are sufficient because ...


We believe that these tests are sufficient because
Binary file modified dump.rdb
Binary file not shown.
Binary file added user_guide_images/fav_btn_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_guide_images/fav_btn_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 398e10a

Please sign in to comment.