One Paragraph of project description goes here
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
Give examples
The command needed to compile/transpile the code into runnable code to the platform you're using
A step by step series of examples that tell you have to get a development env running
Say what the step will be
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
Sometimes we need to change things and we might not fully understand how it works.
List the commands and setup necessary to debug this application
Example:
npm run debug
or in your editor
Give an example
Explain how to run the automated tests for this system
Example:
npm run test
Explain what these tests test and why
Example:
npm run test:debug
Explain what these tests test and why
Example:
npm run lint
list the commands necessary to execute a code coverage
Example:
npm run coverage
There should be some logging convention that needs to be linked or outlined here
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
- Hat tip to anyone who's code was used
- Inspiration
- etc