Your project should be a modern MVC web application with a fresh and custom design. Ensure you create original content, avoiding any reuse of code from old example projects or previous coursework.
Write each line of code with intent, each class, and each method. This project will be all you. It should demonstrate clear comprehension of the course material and ultimately become something you can be truly proud of!
Standalone Project Requirements
- This project should be created within its own GitHub repository.
- The repo should contain a README file that clearly describes in detail how to set up, run, and use the project.
- This project should demonstrate clean, organized code structure and abundant documentation (comments, JavaDoc, etc.)
Three Tier Architecture (Controller <-> Service <-> Repository)
- Ensure that your project is meticulously organized with each component thoughtfully placed, following best practices for clean code architecture.
Demonstrate Understanding and Use of Core Spring Technologies
- Dependency Injection, Events, Testing, etc.
Spring Web MVC / Thymeleaf Templates
- Fully functioning user interface.
- Allowing someone to register and log in, then use the application as intended.
- All visible buttons and links should be functional.
- All images and other resources should be able to load successfully.
- Unified user interface.
- Navigation, headers, etc. should be consistent across all pages via fragments.
- All pages should share CSS styling (Bootstrap, custom, or other).
- Each page should look like it belongs in the application.
Here is an example of a user interface that still needs some work:
Here is an example of a user interface that meets the requirements:
API Integration
- This application must also integrate with a third-party API.
- It should demonstrate at least GET and POST functionality.
- The CodingNomads Tasks API can be used for simplicity.
http://demo.codingnomads.co:8080/tasks_api/swagger-ui/index.html
- The CodingNomads Tasks API can be used for simplicity.
Spring Data JPA
- This application must use a relational database with correctly modeled relationships.
Spring Security
- This application must enable people to create accounts and log in.
- Include several types of users, each with different levels of authorization. For example:
- Guest
- User
- Admin
Spring AOP / Logging
- This application must use AOP to log method interactions, exceptions, etc.
Caching
- This application must leverage caching to speed up requests.
Exception Handling
- Implement a global exception handler and utilize custom exceptions.
Documentation / Comments
- All classes and methods should include proper JavaDoc
Deployed to AWS
- The project should be up and running and accessible for review.
Create a README File
A part of every complete project is a great README file where you describe what your project is all about. Before sharing your project with other people or showing it to potential employers, you should always include a solid description and set of instructions.
Luckily, we've created a lesson about how to make a great README file.
Additional Readme Resources
If you're looking for more README guidance, here is a great website that has a concise overview of all you need to know about making READMEs: https://www.makeareadme.com/
If you want to dive deeper, there is an entertaining course dedicated to writing README files freely available on Udacity. This is purely optional, but it might be a fun break.
Once you've finished writing a README file for your capstone project, you are ready to submit it for review by your mentor or post a link on Discord.
You Got This
Alright, with guidance in hand, it's time to get started! Take your time and utilize all available resources to make this project something special. Think outside the box, think real-world. It's all been leading up to this, keep up the great work that has taken you this far!