# Remedy Effectiveness Rating

[SylvieDoumet]

Value Proposition

As a user of the Homemade Remedies App, I want to rate and review the effectiveness of remedies I have tried, so that I can share my experiences with others and help improve the app’s remedy recommendations.

Description

Acceptance Criteria

• [ ] Users must be logged in to rate remedies or submit reviews.
• [ ] Users can rate remedies on a scale of 1 to 5 stars. The selected rating is visually represented using a UI star rating component.
• [ ] Review text input is required alongside the star rating. Users can submit detailed reviews, including their experience, results, and additional comments. The username of the logged-in user is displayed with each review.
• [ ] A confirmation message appears upon successful submission of a rating and review.
• [ ] Input validation ensures users cannot submit empty reviews or ratings.
• [ ] User ratings and reviews are stored in a MongoDB database, linked to user accounts.
• [ ] An average is calculated and updated after every user rating.
• [ ] For a logged in user each remedy's detail page shows:
  • A UI component to rate remedies by star selection and a text input field
  • The average rating calculated from all submitted ratings.
  • A list of user reviews, including the rating, review text, username, and user icon.
  • These elements are not visible for a logged out user
• [ ] The rating and reviews are disabled for printing.

Tasks

• [ ] Create a feature branch feature/rating
• [ ] Modify remedy/[id]/index.js to check using useEffect if the user is logged in.
• [ ] Create a star rating component by creating a file StarRating.js within the components folder. Create a UI component that allows users to rate remedies on a scale of 1 to 5 stars by selection. Create a form for users to submit detailed reviews. Pass the logged-in username to the StarRating component and manage rating submissions with a handler function. Provide confirmation messages for successful submissions and handle errors accordingly. Ensure the review and rating fields are validated before submission.
• [ ] Integrate the star rating component into the RemedyDetailsPage (remedy/[id]/index.js )
• [ ] Implement backend logic within models/Review.js: Create a MongoDB schema to store ratings and reviews linked to user accounts
• [ ] Implement API Endpoints within pages/api/reviews,js. Create API routes to handle the submission and retrieval of ratings and reviews. In the API endpoint for retrieving ratings, calculate the average rating from the ratings array. Use :

  const getAverageRating = (reviews) => {
  if (reviews.length === 0) return 0;
  const total = reviews.reduce((acc, review) => acc + review.rating, 0);
  return (total / reviews.length).toFixed(1);
  };

• [ ] Fetch and display reviews and average rating for each logged in user from the database in remedy/[id]/index.js.
• [ ] If not possible during the creation process but only after backend implementation, update the UI of StarRating.js to display the username and user icon as part of the review display.
• [ ] Ensure to test the integration with MongoDB and the user authentication process.

[ahohnsen]

Hey there!

As discussed in today’s Backlog Grooming, the rating feature will be developed after the backend and login implementation. Please review your wireframes and acceptance criteria again. If the ratings won’t be anonymous, you need to indicate that. I suggest displaying the username and possibly the date of the review as well.

Additionally, it would be helpful to specify in the acceptance criteria whether including a text review is mandatory or if just submitting the star rating is enough.

[SylvieDoumet]

I'll rework that

[F-Kirchhoff]

Hey Sylvie, looks awesome! Its a pretty big user story, so be aware that this might be a big PR which will take a long time to be reviewed as well. There is one thing missing in the AC and Tasks: In the description is an average Rating component visible, but its not described anywhere else. Please fix that and specify, if the average rating is also only visible if a user is logged in or not. And don't forget to add a task description on how to calculate the average.

[SylvieDoumet]

Thank you We updated your recommendations !

[F-Kirchhoff]

This looks good, even added the solution for the average to the tasklist. next time it is enough to just add "calculate the rating average", but now you already have the solution noted down, which is nice.