[Optional] If what is being submitted is an individual Lab or Assignment. Otherwise, include a brief one paragraph description about the project.
- Date Created: DD MMM YYYY
- Last Modification Date: DD MMM YYYY
- Lab URL: http://example.com/
- Git URL: http://example.com/
[Optional] If what is being submitted is an individual Lab or Assignment, you may simply include your name and email address. Otherwise list the members of your group.
[Optional] If needing to provide the marker with a copy of the project that should run on their local machine for development, testing and/or marking purposes. Please include the following sections.
See deployment for notes on how to deploy the project on a live system.
To have a local copy of this lab / assingnment / project up and running on your local machine, you will first need to install the following software / libraries / plug-ins
Give examples or provide a list of the required software / libraries / plug-ins
See the following section for detailed step-by-step instructions on how to install this software / libraries / plug-ins
A step by step series of examples that tell you how to get a development env running
Say what the step will be, assume the marker just acquired a computer
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo. You may also include a quick example of what the marker should see if the installation of all required software / libraries / plug-ins was successful.
If needing to run automated tests, then explain how to run the automated tests for this system. If this section is not needed, ** you may delete **.
Explain what these tests test and why
Give an example
Explain what these tests test and why
Give an example
Add additional notes about how to deploy this on a live system
- Dropwizard - The web framework used
- Maven - Dependency Management
- ROME - Used to generate RSS Feeds **
If in completing your lab / assignment / project you used any interpretation of someone else's code, then provide a list of where the code was implement, how it was implemented, why it was implemented, and how it was modified. See the sections below for more details.
Lines ## - ##
Copy and paste your code on lines mentioned
The code above was created by adapting the code in NAME as shown below:
Copy and paste the snippet of code you are referencing
- The code in [NAME](link) was implemented by...
- [NAME](link)'s Code was used because...
- [NAME](link)'s Code was modified by...
Repeat as needed
Lines ## - ##
Copy and paste your code on lines mentioned
The code above was created by adapting the code in NAME as shown below:
Copy and paste the snippet of code you are referencing
- The code in [NAME](link) was implemented by...
- [NAME](link)'s Code was used because...
- [NAME](link)'s Code was modified by...
Repeat as needed
- Hat tip to anyone whose code was used
- Inspiration
- etc