documentação
source link: https://gist.github.com/reginadiana/e044fe93ed81aa04a10361cb841c0409
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Titulo ou Arte do Projeto
Status do Projeto: (concluido, em desenvolvimento, etc)
Tópicos
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
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:
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
Liste o time responsável pelo desenvolvimento do projeto
Licença
The MIT License (MIT)
Copyright Ano - Titulo do Projeto
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK