diff --git a/UserGuide.md b/UserGuide.md new file mode 100644 index 0000000000..9fcce609c2 --- /dev/null +++ b/UserGuide.md @@ -0,0 +1,29 @@ +### 1. Feature Overview: + +Feature Name: Endorse Post +Purpose: This feature enables TAs and professors to endorse posts, notifying all viewers that the content has been approved or supported by a professor or TA. It offers students a clear and reliable indicator of posts containing verified, legitimate information that they should prioritize reading. +Coder: Evelynn Chen, Vicky Chen, and Alice Le + +### 2. Steps to test feature +Step 1: Sign into an authorized account (Professor or TA account) +Step 2: Enter and click into a published post +Step 3: Click on the Endorse button + + +### 3. Expected Result: +The endorse button on the post will no longer be available until someone unendorses the post by clicking on unendorse + (TA or Professor only) +Some sort of visual tag will appear on the post showing a TA or Professor has endorsed this post + +### Automated Tests + +### 1. Test Location +**Location**: test/posts.js, lines [135-165](https://github.com/CMU-313/nodebb-f24-boba/blob/f24/test/posts.js#L135-L165) + +### 2. What is Being Tested +- **Tested Features**: The API for toggling the endorsed field for a Post. +- **Test Type**: Unit tests / back-end tests. + +### 3. Coverage Justification +- **Coverage Justification**: +The tests cover all use cases of toggling the boolean field endorsed. By default, a post is not endorsed, and only one request to endorse/unendorse at a time should be processed. \ No newline at end of file