forked from CMU-313/cmu-313-f24-nodebb-f24-NodeBB
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added user guide file and image folders.
- Loading branch information
jullia andrei
committed
Oct 10, 2024
1 parent
e332479
commit dda6ff6
Showing
4 changed files
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# User Guide for User Stories | ||
## Team SWEethearts | ||
|
||
## Table of Contents | ||
|
||
1. [User Story 2](#user-story-2) | ||
2. | ||
|
||
|
||
## 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. | ||
 | ||
 | ||
|
||
* 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. | ||
 | ||
|
||
### How To Use and Test User Story 2 Feature | ||
1. Register 2 accounts: an admin and a non-admin (student). | ||
2. Log in to the non-admin account and make a topic in a discussion board. | ||
3. Go to the user settings page by clicking on the top right profile icon then "Settings". | ||
4. Scroll down until you find the course faculty notification setting as shown below. This feature's setting should be on the "Notification Only" by default. Choose your preferred setting and press Save Changes. | ||
5. Log out of this student account and log in to the admin account. | ||
6. Leave a reply to the student post. | ||
7. Log out and log in the student account. There should now be a new notification that pops up on the notification sidebar and on the page. | ||
* If this setting is turned off then there should be no notifications on the inbox or on the notification page. | ||
|
||
**Note: For this feature we assume that every admin account is a course faculty.** | ||
|
||
### Automated Tests - located in *test/notifications.js* | ||
|
||
#### Error Tests: Testing invalid inputs | ||
* Test for | ||
|
||
#### Valid Tests | ||
|
||
|
||
|
||
|
||
#### Test Justification | ||
We believe that these tests are sufficient because ... | ||
|
||
|
||
## User Story | ||
|
||
|
||
|
||
### How to Use and Test User Story | ||
|
||
|
||
### Automated tests are located in (WRITE FILE NAME HERE) | ||
|
||
#### Error Tests: Testing invalid inputs | ||
* Test for invalid input | ||
|
||
#### Valid Tests | ||
|
||
#### Test Justification | ||
We believe that these tests are sufficient because ... | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.