diff --git a/UserGuide.md b/UserGuide.md index e5f33242b3..20f8f4ed52 100644 --- a/UserGuide.md +++ b/UserGuide.md @@ -2,8 +2,7 @@ ## 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. @@ -11,14 +10,14 @@ As a student, I want to receive an immediate notification when a course faculty ### 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. - Screenshot 1 + Screenshot 1 Screenshot 2 * 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. -Screenshot 3 +Screenshot 3 ### How To Use and Test User Story 2 Feature 1. Register 2 accounts: an admin and a non-admin (student). @@ -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. @@ -43,15 +42,26 @@ 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 + Screenshot 4 + Screenshot 5 ### 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 @@ -59,6 +69,4 @@ We believe that these tests are sufficient as it tests the basic functionality o #### Valid Tests #### Test Justification -We believe that these tests are sufficient because ... - - +We believe that these tests are sufficient because diff --git a/dump.rdb b/dump.rdb index 16da9a5145..41cbe99459 100644 Binary files a/dump.rdb and b/dump.rdb differ diff --git a/user_guide_images/fav_btn_1.png b/user_guide_images/fav_btn_1.png new file mode 100644 index 0000000000..32be31a453 Binary files /dev/null and b/user_guide_images/fav_btn_1.png differ diff --git a/user_guide_images/fav_btn_2.png b/user_guide_images/fav_btn_2.png new file mode 100644 index 0000000000..2ad8282f5d Binary files /dev/null and b/user_guide_images/fav_btn_2.png differ