Trustworthy Product Reviews Application

This project is a Java-based application for managing product reviews, user-following relationships, and categorization of products. The application uses Jakarta Persistence (JPA) to map classes to a relational database.

Designers

• Matthew Khoury, Student # 101188452
• Evan Baldwin, Student # 101222276
• Anabella Villeneuve, Student # 101182327
• Sebastian Lionais, Student # 101157892

Project Roadmap

Milestone 1

Timeline: Started 2024-11-04, Completed 2024-11-04

Functionality added:

• Github was established with functional Github Actions, Kanban Board, and Azure CI
• Spring configurations, dependencies, and classes added to project repository
• Created backend functionality for Products, Customers, and Reviews
• Added thorough JUnit testing for unit and http tests
• Created html pages for home screen and product page
• Created Product controller and repository
• Designed and implemented an in-memory database schema
• Created documentation of the project including a UML diagram

Objectives for next milestone:

• Select a persistent database and begin implementation with Azure
• Add TestContainer implementation for integration tests
• Add default values to avoid utilizing a 3rd party HTML program
• Add Customer and Review controllers with corresponding CRUD repositories
• Implement new html pages for information such as Customer info and reviews
• Add a Customer account system with login features and associated functionality
• Expand integration testing and add testing for new features

Milestone 2

Timeline: Started 2024-11-11, Completed 2024-11-25

Functionality added:

• PostgreSQL was chosen as a suitable persistent database
• Implemented PostgreSQL as a remote database with Azure
• Established TestContainer functionality with new integration testing
• Added a functional login system with Customer accounts and passwords
• Added default values for users and products
• Added new html pages including functionality for viewing reviews and account info
• Added new controllers for Reviews and Customers
• Implemented some additional testing for new functionality

Objectives for next milestone:

• Finish review functionality and associated front-end features
• Add additional unit and integration testing for new methods
• Add functions for sorting reviews average rating
• Implement ability to list users by parameters such as most followers, following, and degree of separation
• Improve webpage visuals via functionality such as headers, footers, images, etc.

Package Structure

• Customer: Represents a user who can follow other users and leave reviews on products.
• Product: Represents a product available for review.
• Review: Represents a review of a product left by a customer, including a rating, text, and date.

Class Descriptions

Customer

Represents a user who can follow other users and leave reviews on products.

• Fields:
  • id (Long): Primary key, auto-generated.
  • userId (String): Unique identifier for each user.
  • name (String): User's name.
  • following (Set): Set of customers that this customer is following.
  • reviews (Set): Set of reviews this customer has made.
• Relationships:
  • Many-to-many relationship with other Customer entities through a join table (user_follows) to represent following relationships.
  • One-to-many relationship with Review entities, where a Customer can have multiple reviews.
• Methods:
  • addFollowing(Customer customer): Adds a customer to the following set.
  • removeFollowing(Customer customer): Removes a customer from the following set.
  • addReview(Review review): Associates a review with the customer.
  • removeReview(Review review): Disassociates a review from the customer.

Product

Represents a product available for review.

• Fields:
  • id (Long): Primary key, auto-generated.
  • productId (String): Unique identifier for each product.
  • name (String): Name of the product.
  • category (String): Product category.
  • reviews (List): List of reviews associated with this product.
• Relationships:
  • One-to-many relationship with Review entities, where a Product can have multiple reviews.
• Methods:
  • addReview(Review review): Associates a review with the product.
  • removeReview(Review review): Disassociates a review from the product.

Review

Represents a review of a product left by a customer, including a rating, text, and date.

• Fields:
  • id (Long): Primary key, auto-generated.
  • reviewer (Customer): The customer who wrote the review.
  • product (Product): The product being reviewed.
  • starRating (int): The rating given to the product, on a scale (e.g., 1-5).
  • reviewText (String): Textual content of the review.
  • reviewDate (LocalDateTime): Timestamp of when the review was created.
• Relationships:
  • Many-to-one relationship with Customer (each review has one customer).
  • Many-to-one relationship with Product (each review relates to one product).

Database Schema

This database schema represents a persistent PostgreSQL database utilized to test this proof of concept. This iteration utilizes a persistent database assocated with Azure that contains data related to products, customers, and reviews. The current iteration deletes added elements once a session has been finished for testing and storage purposes.

Primary keys are represented by an underline, and foreign keys contain an arrow associated with their respective primary keys.

UML Diagram

This UML Diagram represents the application as of Milestone 2. The diagram will be updated periodically to accound for any new classes, attributes and methods implemented alongside commits.