mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-03 01:52:42 +02:00
102 lines
3.0 KiB
Markdown
102 lines
3.0 KiB
Markdown
<p align="center">
|
|
<a href="" rel="noopener">
|
|
<img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
|
|
</p>
|
|
|
|
<h3 align="center">Project Title</h3>
|
|
|
|
<div align="center">
|
|
|
|
[]()
|
|
[](https://github.com/kylelobo/The-Documentation-Compendium/issues)
|
|
[](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
|
|
[](/LICENSE)
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
<p align="center"> Few lines describing your project.
|
|
<br>
|
|
</p>
|
|
|
|
## 📝 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 <a name = "about"></a>
|
|
Write about 1-2 paragraphs describing the purpose of your project.
|
|
|
|
## 🏁 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.
|
|
|
|
## 🔧 Running the tests <a name = "tests"></a>
|
|
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 <a name="usage"></a>
|
|
Add notes about how to use the system.
|
|
|
|
## 🚀 Deployment <a name = "deployment"></a>
|
|
Add additional notes about how to deploy this on a live system.
|
|
|
|
## ⛏️ Built Using <a name = "built_using"></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
|
|
|
|
## ✍️ 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.
|
|
|
|
## 🎉 Acknowledgements <a name = "acknowledgement"></a>
|
|
- Hat tip to anyone whose code was used
|
|
- Inspiration
|
|
- References
|