Update Hackathon.md

Templates/Hackathon.md

@@ -0,0 +1,112 @@
+<p align="center">
+  <a href="" rel="noopener">
+ <img src="https://cdn-images-1.medium.com/max/1600/1*supQ92uykNElEfyYf7UgHw.png" alt="Project logo"></a>
+</p>
+<h3 align="center">Project Title</h3>
+
+<div align="center">
+
+  [![Hackathon](https://img.shields.io/badge/hackathon-name-orange.svg)](http://hackathon.url.com) 
+  [![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.md)
+
+</div>
+
+---
+
+<p align="center"> Few lines describing your project.
+    <br> 
+</p>
+
+# Table of Contents
++ [Problem Statement](#problem_statement)
++ [Idea / Solution](#idea)
++ [Dependencies / Limitations](#limitations)
++ [Future Scope](#future_scope)
++ [Setting up a local environment](#getting_started)
++ [Technology Stack](#tech_stack)
++ [Contributing](../CONTRIBUTING.md)
++ [Authors](#authors)
++ [Acknowledgments](#acknowledgments)
+
+## Problem Statement <a name = "problem_statement"></a>
+It is useful to design and follow a specific format when writing a problem statement. While there are several options
+for doing this, the following is a simple and straightforward template often used in Business Analysis to maintain
+focus on defining the problem.
+
++ IDEAL: This section is used to describe the desired or “to be” state of the process or product. At large, this section 
+should illustrate what the expected environment would look like once the solution is implemented.
++ REALITY: This section is used to describe the current or “as is” state of the process or product. 
++ CONSEQUENCES: This section is used to describe the impacts on the business if the problem is not fixed or improved upon.
+This includes costs associated with loss of money, time, productivity, competitive advantage, and so forth.
+
+Following this format will result in a workable document that can be used to understand the problem and elicit
+requirements that will lead to a winning solution. 
+
+## Idea / Solution <a name = "idea"></a>
+This section is used to describe potential solutions. 
+
+Once the ideal, reality, and consequences sections have been 
+completed, and understood, it becomes easier to provide a solution for solving the problem.
+
+## Dependencies / Limitations <a name = "limitations"></a>
++ What are the dependencies of your project?
++ Describe each limitation in detailed but concise terms
++ Explain why each limitation exists
++ Provide the reasons why each limitation could not be overcome using the method(s) chosen to acquire.
++ Assess the impact of each limitation in relation to the overall findings and conclusions of your project, and if 
+appropriate, describe how these limitations could point to the need for further research.
+
+## Future Scope <a name = "future_scope"></a>
+Write about what you could not develop during the course of the Hackathon; and about what your project can achieve 
+in the future.
+
+## Built With <a name = "tech_stack"></a>
++ [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
+
+## Getting Started <a name = "getting_started"></a>
+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.
+
+## Authors <a name = "authors"></a>
+
++ [@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.
+
+## Acknowledgments <a name = "acknowledgments"></a>
++ Hat tip to anyone whose code was used
++ Inspiration
++ References