Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Template sugestivo para documentação de projetos

Titulo ou Arte do Projeto

Status do Projeto: ✔️ ⚠️ (concluido, em desenvolvimento, etc)

Tópicos

🔹 Descrição do projeto

🔹 Funcionalidades

🔹 Deploy da Aplicação

🔹 Pré-requisitos

🔹 Como rodar a aplicação

...

Insira os tópicos do README em links para facilitar a navegação do leitor

Descrição do projeto

Descrição breve do projeto compondo um paragrafo ou dois.

Funcionalidades

✔️ Funcionalidade 1

✔️ Funcionalidade 2

✔️ Funcionalidade 3

✔️ Funcionalidade 4

Layout ou Deploy da Aplicação 💨

Link do deploy da aplicação. Exemplo com netlify: https://certificates-for-everyone-womakerscode.netlify.app/

...

Se ainda não houver deploy, insira capturas de tela da aplicação ou gifs

Pré-requisitos

⚠️ Node

...

Liste todas as dependencias e libs que o usuário deve ter instalado na máquina antes de rodar a aplicação

Como rodar a aplicação ▶️

No terminal, clone o projeto:

git clone https://github.com/React-Bootcamp-WoMarkersCode/certificate-generator

...

Coloque um passo a passo para rodar a sua aplicação. Dica: clone o próprio projeto e verfique se o passo a passo funciona

Como rodar os testes

Coloque um passo a passo para executar os testes

$ npm test, rspec, etc 

Casos de Uso

Explique com mais detalhes como a sua aplicação poderia ser utilizada. O uso de gifs aqui seria bem interessante.

Exemplo: Caso a sua aplicação tenha alguma funcionalidade de login apresente neste tópico os dados necessários para acessá-la.

JSON 💾

Usuários:

name email password token avatar
Lais Lima laislima98@hotmail.com lais123 true https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcS9-U_HbQAipum9lWln3APcBIwng7T46hdBA42EJv8Hf6Z4fDT3&usqp=CAU

...

Se quiser, coloque uma amostra do banco de dados

Iniciando/Configurando banco de dados

Se for necessário configurar algo antes de iniciar o banco de dados insira os comandos a serem executados

Linguagens, dependencias e libs utilizadas 📚

...

Liste as tecnologias utilizadas no projeto que não forem reconhecidas pelo Github

Resolvendo Problemas

Em issues foram abertos alguns problemas gerados durante o desenvolvimento desse projeto e como foram resolvidos.

Tarefas em aberto

Se for o caso, liste tarefas/funcionalidades que ainda precisam ser implementadas na sua aplicação

📝 Tarefa 1

📝 Tarefa 2

📝 Tarefa 3

Desenvolvedores/Contribuintes :octocat:

Liste o time responsável pelo desenvolvimento do projeto


Diana Regina

Diana Regina

Diana Regina

Licença

The MIT License (MIT)

Copyright ©️ Ano - Titulo do Projeto

@josemalcher

This comment has been minimized.

Copy link

@josemalcher josemalcher commented May 21, 2020

Parabéns pela formulação desse README's! Inspirador!

Pretendo aplicar nos meus... que estão bem sem graça 😢

Abraços!

@reginadiana

This comment has been minimized.

Copy link
Owner Author

@reginadiana reginadiana commented May 21, 2020

Obrigada!! Boa documentação!!

@magdielndantas

This comment has been minimized.

Copy link

@magdielndantas magdielndantas commented Jul 8, 2020

Muito bom, Diana! Achei ótimo teu post e vim correndo conferir o template haha

@reginadiana

This comment has been minimized.

Copy link
Owner Author

@reginadiana reginadiana commented Jul 8, 2020

Obrigada!! Fico feliz :)

@caparra92

This comment has been minimized.

Copy link

@caparra92 caparra92 commented Jul 10, 2020

Muito bom Diana, me inspirei bastante depois de ler seu artigo, bora refatorar meus README, tenho um com vue no qual vou aplicar estes conceitos.

Obrigado.

@reginadiana

This comment has been minimized.

Copy link
Owner Author

@reginadiana reginadiana commented Jul 10, 2020

Fico feliz :) Obrigada você

@tkusuki

This comment has been minimized.

Copy link

@tkusuki tkusuki commented Jul 20, 2020

❤️ muito bom!

@reginadiana

This comment has been minimized.

Copy link
Owner Author

@reginadiana reginadiana commented Jul 20, 2020

Obrigada :)

@goj1

This comment has been minimized.

Copy link

@goj1 goj1 commented Jul 24, 2020

Topzera isso aí!

@Kaueny-Alves

This comment has been minimized.

Copy link

@Kaueny-Alves Kaueny-Alves commented Jul 25, 2020

Parabéns, ficou excelente a documentação.
Obrigada por compartilhar!!!

@tchelaalvino

This comment has been minimized.

Copy link

@tchelaalvino tchelaalvino commented Aug 4, 2020

Muito bom, obrigada por compartilhar :)

@thiagodsalles

This comment has been minimized.

Copy link

@thiagodsalles thiagodsalles commented Aug 5, 2020

Parabéns pelo trabalho! Já está salvo nos meus favoritos.

@bielmoita

This comment has been minimized.

Copy link

@bielmoita bielmoita commented Aug 23, 2020

Caramba, um trabalho incrível, Estou aprendendo muito com esse template.
Parabéns!

@luisPiresQA

This comment has been minimized.

Copy link

@luisPiresQA luisPiresQA commented Sep 2, 2020

Parabéns! vai ajudar muito para quem esta começando como eu kkkk.

@danielbarroslima

This comment has been minimized.

Copy link

@danielbarroslima danielbarroslima commented Sep 10, 2020

Nossa gostei muito de tudo, estava procurando uma melhor forma de documentar aplicações, e a sua é muito, muito, muito boa mesmo. Gostei, nota 1000.

@GustavoHerreroNunes

This comment has been minimized.

Copy link

@GustavoHerreroNunes GustavoHerreroNunes commented Sep 16, 2020

Gostei bastante do artigo e desse modelo de README, estou começando e vai me ajudar bastante😀👍

@emersonpessoa01

This comment has been minimized.

Copy link

@emersonpessoa01 emersonpessoa01 commented Sep 25, 2020

Parabéns Regina pelo fantástico trabalho! me ajudou pra caramba, principalmente pra criar os badges. Agora eu já tentei criar um badges com a logo do NODE só não aparece a logo. Tem alguma uma dica pra isso?!

@reginadiana

This comment has been minimized.

Copy link
Owner Author

@reginadiana reginadiana commented Oct 2, 2020

@emersonpessoa01

Puts, tem alguns logos que não estão disponíveis mesmo. Uma coisa que a galera faz é mandar uma url da imagem como parâmetro na logo. Encontrei esse tópico no stackoverflow.

Ele fala basicamente que tu precisa de uma imagem com base64. Podemos usar esse site que faz a conversão de uma imagem para esse tipo de base e colocar na LOGO. Porém, não achei que foi um caminho muito consistente, mesmo fazendo a conversão não foram todas as imagens que deram certo.

Uma alternativa que achei bacana foi essa da documentação dos shields.

Eles usam o site Simple Icons. Podemos simplesmente referenciar o nome que queremos. Exemplo:

Escolhi esse icon aqui (sim, esse é o logo de node que eles tem, pelo menos foi o que achei).

Show, poderíamos ter um badge da seguinte forma:

https://img.shields.io/static/v1?label=nodejs&message=backend&color=green&style=for-the-badge&logo=node.js

Parece ter muitos icons disponíveis!!

@emersonpessoa01

This comment has been minimized.

Copy link

@emersonpessoa01 emersonpessoa01 commented Oct 2, 2020

Show de bola, Regina!!! Obrigado.

@MrFMach

This comment has been minimized.

Copy link

@MrFMach MrFMach commented Nov 5, 2020

Shoooooowww Regina!
Vai me ajudar muito!!!
Obrigado e Parabéns!

@anglesson

This comment has been minimized.

Copy link

@anglesson anglesson commented Nov 16, 2020

Muito bom!!! Parabéns!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment