Imagem da capa aqui.
Descrição • Pastas • Funcionalidades • Status • Rodar • Testes • Desenvolvedores
Uma breve descrição do projeto. A equipe deve incluir as badges das tecnologias, como:
-
Raíz
├── src
└── config
└── controllers
└── errors
└── middlewares
└── models
└── routes
├── tests
Descreva a estrutura utilizada. A equipe deve ser clara, não assumindo que o leitor entende a arquitetura utilizada.
- Funcionalidade implementada
- Funcionalidade pendente/em produção
✅ Concluído ✅ 🚧 Em andamento 🚧 💡 Em atualização 💡
# Passo a passo para rodar o projeto localmente. A equipe deve ser detalhista,
# informando desde a clonagem do repositório até a configuração de variáveis de ambiente.
...
# Passo a passo para rodar o os testes do projeto localmente.
# Segue as orientações supracitadas no tópico sobre como rodar a aplicação.
...
Exemplo:
Victor G. Marques Diretor |
Raphaela G. Ferraz Front-end |
Feito com 💙 por Equipe XX - Diretoria XX
© InAI