REPO README

Repo ReadMe

There's a lot we can do to encourage code reuse, sharing, and onboarding of new team members. For instance, Every GitHub repo should fill in the short description and website link at the top. Also, a GitHub repository needs a proper Readme to best help out our teammates.

The belief here is that repo should have a few defining traits to make it easy for anyone to understand its purpose, set it up, run its tests, and work towards contributing to it.

Each Repo's readme should follow this basic structure:

## Repo Name [codeclimate badge] [testing badge]

1 sentence tag line

# Description

3-5 sentences describing the code and what it's purpose is

## Documentation

List of endpoints exposed by the service

## Setup

Step by step instructions on how to get the code set up locally. This may include:

### Dependencies

List of libraries, tools, etc needed (e.g. yarn, node.js, python, etc)

### Getting Started

List of steps to get started (e.g. clone repo, submodule, .env file, etc)

### Run The Service

List of steps to run the service (e.g. docker commands)

### Microservices

List out the microservices if any that this repo uses

## Testing

Step by step instructions on how to run the tests so that the developer can be sure they've set up the code correctly

## Contribute

Any instructions needed to help others contribute to this repository

## Deployment

Step by step instructions so that the developer can understand how code gets updated