slor8 / iBookTracker

0 stars 0 forks source link

Peer Review #4

Open avmarks opened 6 years ago

avmarks commented 6 years ago

Design/Code Review 1

Project: Vocab - Sharing

Developer: Xinan Wan

Reviewer: Alexandra Marks

Item Considerations Comments/Suggestions
Reviewer comments and suggestions go here. Each item should have at least one "kudos" and two suggestions for improvement
Problem Statement 1. Accurately describes project purpose
2. Is professional and free of typos, slang, etc.
3. Fully explains the problem and the solution
4. Is understandable by the average person
Great job at outlining the project purpose. I fully understood the problem that you were trying to solve.
There are few minor grammar/wording issues. You might like to rewrite it in this fashion: "Tracking is hard when it comes to borrowing or lending books from your own library. Even when it is written down on paper, it could be lost. When multiple people borrow multiple items, it is not easy to remember all the details. iBookTracker application will help in this process. It will automatically track the dates, names, borrowed and available books."
Design Documentation 1. Navigation/flow through the application is logical and easy to use.
2. The order in which values are displayed are logical and easy to understand/use
3. The order in which the form fields entered are logical and easy to understand/use
4. All data discussed/documented (problem statement, flow, db design, etc.) is represented on the screens
Great job at creating the generic DAO and the data models. I also liked the screen designs. Logical flow that is easy to follow.
I would suggest adding the database tables that you have so far, even if it is only two of them. In Intellij, under database tools, you can select Diagrams/show visualization.
In the Application Flow under User Log-In, point 3. you might want to replace 'handler' with 'handle'.
Data model/Database 1. Everything on the screens and problem statement/flow is represented in the model
2. There is at least one 1-to-many relationship.
3. The model represents good database design
Good job at creating the 1-to-many.
So far as the course goes there is a good database design. As mentioned above the addition of database screens would be a good touch.
Code 1. Proper Maven project structure is used
2. a .gitignore file for IntelliJ Java projects has been implemented
3. There is not any redundant or copy/paste code in the JSPs or classes
4. Classes are appropriately-sized (no monster classes)
Property files are used appropriately: no hard-coded values
5. Logging statements are used rather than System.out.println and printStackTrace.
6. There are appropriate unit tests/code coverages.
Proper Maven objects are used. Logging statements are moved in a separate file. Great job at keeping it clean at the command line. Suggestion would be to work on the jsp file on displaying the data that you have so far. Although from class on Thursday it sounded that you are on track with that.