Project Title

[![Status](https://img.shields.io/badge/status-active-success.svg)]() [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

---

Few lines describing your project.

## 📝 Table of Contents - [About](#about) - [Getting Started](#getting_started) - [Deployment](#deployment) - [Usage](#usage) - [Built Using](#built_using) - [TODO](../TODO.md) - [Contributing](../CONTRIBUTING.md) - [Authors](#authors) - [Acknowledgments](#acknowledgement) ## 🧐 About Write about 1-2 paragraphs describing the purpose of your project. ## 🏁 Getting Started These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. ### Prerequisites What things you need to install the software and how to install them. ``` Give examples ``` ### Installing 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 ``` And repeat ``` until finished ``` End with an example of getting some data out of the system or using it for a little demo. ## 🔧 Running the tests Explain how to run the automated tests for this system. ### Break down into end to end tests Explain what these tests test and why ``` Give an example ``` ### And coding style tests Explain what these tests test and why ``` Give an example ``` ## 🎈 Usage Add notes about how to use the system. ## 🚀 Deployment Add additional notes about how to deploy this on a live system. ## ⛏️ Built Using - [MongoDB](https://www.mongodb.com/) - Database - [Express](https://expressjs.com/) - Server Framework - [VueJs](https://vuejs.org/) - Web Framework - [NodeJs](https://nodejs.org/en/) - Server Environment ## ✍️ Authors - [@kylelobo](https://github.com/kylelobo) - Idea & Initial work See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project. ## 🎉 Acknowledgements - Hat tip to anyone whose code was used - Inspiration - References