1
0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-03 01:52:42 +02:00

translated standard template

This commit is contained in:
Alberto Mosconi
2020-09-05 17:04:41 +02:00
parent 5e501a4e89
commit 64c01d1234

View File

@@ -0,0 +1,115 @@
<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">Titolo del Progetto</h3>
<div align="center">
[![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)
</div>
---
<p align="center"> Poche righe di descrizione del tuo progetto.
<br>
</p>
## 📝 Table of Contents
- [Descrizione](#about)
- [Come Iniziare](#getting_started)
- [Distribuzione](#deployment)
- [Utilizzo](#usage)
- [Costruito Con](#built_using)
- [TODO](../TODO.md)
- [Contribuire](../CONTRIBUTING.md)
- [Autori](#authors)
- [Riconoscimenti](#acknowledgement)
## 🧐 Descrizione <a name = "about"></a>
Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo progetto.
## 🏁 Come Iniziare <a name = "getting_started"></a>
Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto.
### Prerequisiti
Di cosa hai bisogno per installare il software e come installarle.
```
Dai esempi
```
### Installazione
Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo.
Indica qual è il passo
```
Dai l'esempio
```
E ripeti
```
Fino alla fine
```
Chiudi con un esempio su come ottenere dei dati dal sistema o su come usarlo per una piccola demo.
## 🔧 Eseguire i test <a name = "tests"></a>
Spiega come eseguire i test automatici per questo sistema.
### Scomponi in test end to end
Spiega cosa e perchè testano questi test
```
Dai un esempio
```
### E test sullo stile del codice
Spiega cosa e perchè testano questi test
```
Dai un esempio
```
## 🚀 Distribuzione <a name = "deployment"></a>
Aggiungi appunti su come deployare questo progetto su un sistema live.
## 🎈 Utilizzo <a name="usage"></a>
Aggiungi note su come usare il sistema.
## ⛏️ Costruito con <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
## ✍️ Autori <a name = "authors"></a>
- [@kylelobo](https://github.com/kylelobo) - Idea & Lavoro iniziare
Vedi anche la lista di [contributori](https://github.com/kylelobo/The-Documentation-Compendium/contributors)
che hanno partecipato a questo progetto.
## 🎉 Riconoscimenti <a name = "acknowledgments"></a>
- Cenno a tutti quelli il cui codice è stato utilizzato
- Ispirazione
- Riferimenti