This Product Reviews Web App is a SpringBoot web application deployed on Azure Web Services. It uses RESTful commands and Thymeleaf calls to organize and display information that is persisted and stored in a database.
Product reviews on the platform are linked to their respective website listings. Each review comprises a star rating and accompanying text. Users have the option to 'follow' others whose reviews they find valuable. They can then organize products within a specific category by their average rating, considering either all users or just those they follow. Additionally, users can identify individuals whose reviewing patterns closely resemble their own using the Jaccard distance metric. Reviews can be further ranked based on the similarity of the reviewers' scores. The platform also allows users to discover the most followed reviewers. To enhance trust, the system indicates the degree of separation between users through their 'follow' connections, assuming closer connections imply higher trustworthiness.
The product entity is responsible for holding the model logic of a typical Product. It contains a name, URL, category, and a list of Reviews related to that product. Users can add and remove products to the site.
The review entity holds the model logic of a typical Review. It contains a star rating and a comment and keeps track of the review's author and related product.
The client entity is responsible for holding the model logic of the typical client. Clients have a username, a map of
product_id, review pairs, a list of users they follow, and a count of how many users follow them - using Degrees of Separation.
Clients can follow and unfollow other clients, write reviews of products, and calculate Jaccard Distance to each other.
- Clone the repository to your machine and run the
ProductReviewsWebAppApplication.javafile - On any web browser, navigate to
localhost:8080, allowing an offline developer view of the project
Prometheus and Grafana can be used to query and visualize a variety of app metrics. To get them working complete the following steps:
- Install docker on your machine (docker installation webpage or
sudo apt install docker.ioon debian) - Install docker compose on your machine (docker compose installation site)
- Run
mvn packagein the project root directory to ensure that the latest version of the project jar file is present - Open the terminal, navigate to the monitoring directory and run
docker-compose up -dordocker compose up -d(depending on how docker compose was installed, docker-compose may not work as sometimes docker compose is included in the docker installation instead of installed individually) - Navigate to URL:
http://localhost:8080for the Product Reviews Web Apphttp://localhost:9090for the Prometheus user interfacehttp://localhost:3000for the Grafana user interface
- Once you are done, navigate to the monitoring directory again and run
docker-compose downto stop the containers
- Once changes are made, re-run
ProductReviewsWebAppApplication.javaand refreshlocalhost:8080on your web browser, the changes should appear - Create a new branch and commit to the repository
- Open a pull request on that branch, once approved, congratulations, you've successfully contributed to Product Reviews Web App!