One Paragraph of project description goes here
Top 5 things about this project
- List of them
High level diagram (component diagram)
- Any specific points of interest
description of the relationship
Indepth description of any data sources
- List all services that consume this with a brief
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.
List of global dependencies and instructions on installation
Give examples
A step by step series of examples that tell you how to get a development env running
Say what the step will be
Give the example
End a smoke test to prove project is running locally
Start project
URL of project
Quick example of how to interact with the system manually.
Explain how to run the automated tests for this system
Explain what these tests test and why
Give an example
Instructions on how to deploy
Document any helper scripts the project has in /scripts.