Checkpoint 1 Review

[hallahhussien]

Design/Code Review 1

Project: Vagante Website

Developer: Lucas Tolly

Reviewer: Hallah

Category	Criteria	Rating/Comments
Problem Statement	Does it exist?	Yes
	Does the problem statement accurately describe project purpose?	Yes
	Is the problem statement professional? Think of prospective employers viewing this as part of the developer's portfolio.	I think it is a good idea, that will show case the things Lucas knows and prospective employers might think the topic is irrelevant but the coding and knowledge of different tools to execute it will be what will make him stand out
	What is good?	Yes
	What could be improved?	Maybe add more detail
Design Documentation	Does it exist?	Yes
	Is the navigation/flow through the application logical and easy to use?	Yes
	Is the order in which the fields are displayed and form fields entered logical and easy to use?	I think they would be easier to understand if i knew more about the game, but they are simple and easy to follow.
	What data is missing?	Nothing that I know of
	Is there data that is not used?	no
	What is good?	Yes
	What could be improved?	Changing names of the design pages. For example secret vs secrets, secret looks like the form to submit a secret and secrets looks like the page for secrets. Maybe different names to keep from confusing users in the long run like "add secret form" and "page of secrets".
Data model	Does it exist?	Yes
	Is everything on the screens represented in the model?	I believe so
	Does the model represent good database design?	Yes
	What is good?	Yes
	What could be better?	More detail
Additional design documents		-
Application structure in IntelliJ	Does it exist?	Yes
	Is the structure correct for a Maven project?	I think so
	Are packages and classs appropriately named?	Yes
	Other comments/notes?	It was not functional for the review so I am excited to see what it will look like when it is up and running!
JSPs	Do they exist?	Yes
	Is templating used (for example, header.jsp, footer.jsp, etc.)?	No
	Is there business logic mixed in the JSPs?	No
	CSS?	No
	Other comments/notes?
Entities/DAOs/Controllers	Do they exist?	No
Java code quality	Are methods single-purpose?
	Are classes appropriately-sized classes (no monster classes)?
	Are the same lines of code repeated at all?
	Do any classes perform very similar functions that could be candidates for super/subclass relationships?
	Are any values hard-coded that should be in a properties file?
	Are variable names descriptive?
	Are there many branches or loops that could be simplified or broken up into smaller methods?
	Do the DAOs use Hibernate? No hard-coded sql!
	Other comments/notes?
Logging	Has log4J been added?
	Are there logging statements in the code?
	Are appropriate logging levels used? Info, debug, error, for example.
	Are there any System.out.printlns in the code?
	Other comments/notes?
Unit Tests	Do they exist?
	Do the tests pass?
	What is the current code coverage?
	Is each test truly a unit test or are they functional tests?
	Other comments/notes?
Web Service/API integration	Has a web service/api been selected?	I believe in class it was discussed that he would be using a certain API to authentic users from Google's API but I can't remember the details of it now - sounded really cool!
	What web services/apis might work well with this application?	In PHP a classmate used an API to keep comments on his website live and constantly refreshing. I think that would be cool to have so that while players a playing the game live, you can keep the comments up to date and ensure that they are getting the help they need in the exact moment.
Independent research topic	Has a topic been selected?	The API for the authentication was the independent topic - Paula approved this
	What topic/s might fit well in this application?	I think he already has a lot on his plate! Maybe the commenting API but if he has time to research it!

[hallahhussien]

There was no Java code shown during the review so I left those parts blank - He has updated since then but I filled out the table with my notes from the day that we did the review