Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ikauematos/model
https://github.com/ikauematos/model
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ikauematos/model
- Owner: iKaueMatos
- Created: 2022-06-05T17:39:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T01:48:41.000Z (6 months ago)
- Last Synced: 2024-05-09T02:44:18.626Z (6 months ago)
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# modelo-README.md
Modelo (template) de README para utilizar nas documentações dos seus projetos no GitHub. Deixe sua ⭐ se curtiu o template, para ficar salvo e utilizar depois.
# Título/Nome do projeto
Descreva brevemente o seu projeto. Aqui você pode utilizar texto e também imagens/diagramas.
* O [Mermaid](https://mermaid.live/edit#pako:eNpVkE1uwjAQha9izapIZFGWWVSCBFZUVCq7mMXInjSW_Fdji6Ikp2HRg3CxmmRDZzV633uj0etBOElQQqvdRXQYIjvW3LI862bttRJ4_73fHHs9saJ4GwJ9JzrHgW1enulqMWc2DxOr-u0PGa_dOKvVFD1YGljd7NFH50_P5HhxA9s26qNzlv6TLlBO7ZoWyxYLgYFVGCYLLMFQMKhk_r5_KBxiR4Y4lHmV1GLSkQO3Y7Ziiu7zagWUMSRaQvISI9UKvwIayLf1OaskVXThfW5kKmb8AyAeX3o) é uma opção bem legal para diagramas e você consegue utilizar diretamente no README.md:
[](https://mermaid.live/edit#pako:eNpVkE1uwjAQha9izapIZFGWWVSCBFZUVCq7mMXInjSW_Fdji6Ikp2HRg3CxmmRDZzV633uj0etBOElQQqvdRXQYIjvW3LI862bttRJ4_73fHHs9saJ4GwJ9JzrHgW1enulqMWc2DxOr-u0PGa_dOKvVFD1YGljd7NFH50_P5HhxA9s26qNzlv6TLlBO7ZoWyxYLgYFVGCYLLMFQMKhk_r5_KBxiR4Y4lHmV1GLSkQO3Y7Ziiu7zagWUMSRaQvISI9UKvwIayLf1OaskVXThfW5kKmb8AyAeX3o)
- No site, vá no campo: Actions > Copy Markdown. Copie o link e cole no seu arquivo README.md e o diagrama estará lá.
### Tecnologias Utilizadas
Liste as tecnologias (linguagens, ferramentas, bibliotecas) que você utilizou para elaborar o projeto. Essa parte é importante para quando um recrutador (que não tem conhecimento de programação) acessar o seu projeto, ele vai saber só olhando a documentação quais tecnologias você já conhece!
Exemplo:
* [Golang](https://github.com/golang/go)
* [Docker](https://www.docker.com/)
* [MySQL](https://www.mysql.com/)
## Dependências e Versões Necessárias
Liste as dependências necessárias para rodar o projeto e as versões que você utilizou.
* Docker - Versão: X.X
## Como rodar o projeto ✅
Descreva o passo a passo necessário para rodar sua aplicação. Lembre-se: a pessoa nunca rodou seu projeto. Não tenha medo de detalhar o máximo possível. Isso é necessário!
Uma boa forma de descrever o passo a passo é:
```
Comando 1
```
Depois, rode o seguinte comando:
```
Comando 2
```
Deixe claro como a pessoa pode confirmar que a aplicação está rodando da forma correta. Pode ser com prints ou a mensagem que ela deve esperar.
## Como rodar os testes
Explique como rodar os testes da aplicação. Exemplo de um comando usando Makefile para rodar os testes:
```
make test
```
## 📌 (Título) - Informações importantes sobre a aplicação (exemplo) 📌
Esse é o local para você preencher com outras informações que possam ser importantes para a aplicação. Coloquei um exemplo de título, mas você deve preencher de acordo com a necessidade do projeto. Pode ser que não seja necessário.
Um bom exemplo: se você estiver construindo uma API, liste as rotas da aplicação e quais serão os seus retornos. Isso facilita para quem vai consumir a API.
## ⚠️ Problemas enfrentados
Liste os problemas que você enfrentou construindo a aplicação e como você resolveu cada um deles. Você que desenvolveu o projeto é a pessoa que mais conhece/entende os possíveis problemas que uma pessoa pode enfrentar rodando a aplicação. Compartilhe esse conhecimento e facilite a vida da pessoa descrevendo-os.
Exemplo:
### Problema 1:
Descrição do problema
* Como solucionar: explicar a solução.
### Problema 2:
Descrição do problema
* Como solucionar: explicar a solução.
## ⏭️ Próximos passos
Descreva se você pretende, pensou ou gostaria de elaborar uma nova feature para o seu projeto definindo os próximos passos.