Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme. #37

Merged
merged 3 commits into from
May 1, 2024
Merged

Updated readme. #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ea1fd8
Update README.md
nhkhai May 1, 2024
9319c89
Updated the readme.
nhkhai May 1, 2024
ea332e5
Merge branch 'main' of https://github.com/nhkhai/TheReviewRoom
nhkhai May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Ports/TheReviewRoom-FastAPI
Open in desktop
Submodule TheReviewRoom-FastAPI updated 1 files
+30 −1 README.md
2 changes: 1 addition & 1 deletion Ports/TheReviewRoom-Go
Open in desktop
Submodule TheReviewRoom-Go updated 1 files
+30 −1 README.md
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ Retailers can manage all customer reviews in a single, user-friendly platform, a
By leveraging customer reviews, retailers gain valuable insights into product performance, identify trends, and make informed decisions regarding product selection, improvement, and marketing strategies.
Project Structure

## The Review Room project utilizes a Spring Boot framework with clear separation of concerns:
## The Review Room project utilizes a Spring Boot framework with clear separation of concerns:

Customer Controller: Manages CRUD operations for customer data. It also handles the creation of new reviews associated with a specific customer.
Product Controller: Manages CRUD operations for product data.
Review Controller: Manages CRUD operations for review data, including filtering reviews by specific criteria (ratings, customer ID, product ID).
Customer Controller: Manages CRUD operations for customer data. It also handles the creation of new reviews associated with a specific customer.
Product Controller: Manages CRUD operations for product data.
Review Controller: Manages CRUD operations for review data, including filtering reviews by specific criteria (ratings, customer ID, product ID).

## Test Coverage

This project prioritizes code quality and maintainability. We've included unit tests for the core functionalities of the application, covering all important aspects of the code. These tests ensure the code behaves as expected and helps prevent regressions during development.
This project prioritizes code quality and maintainability. We've included unit tests for the core functionalities of the application, covering all important aspects of the code. These tests ensure the code behaves as expected and helps prevent regressions during development.

## Front End

A basic front end to highlight an MVP of our project can be found at: https://github.com/kiblykat/ReviewRoom-frontend
A basic front end to highlight an MVP of our project can be found [here](https://github.com/kiblykat/ReviewRoom-frontend).
Loading