Título do Projeto | EJCM

Esse é o modelo de ReadMe para os projetos da EJ, feito com a finalidade de padronizar a documentação técnica da empresa. Em cada tópico você verá uma explicação do que deve ser escrito e você deverá personalizar os tópicos de acordo com o seu projeto.

Se tiver dúvidas sobre a sintaxe do Markdown, pode ver esse link: https://github.com/luong-komorebi/Markdown-Tutorial/blob/master/README_pt-BR.md#sintaxe-do-markdown.

Se tiver dúvidas sobre as badges, pode ver esses links: Repositórios com Badges • Como customizar badges

Se quiser ver um exemplo de read me completo pode ver esses links: Shrlocke, Cenabio e Anthrakos

Aqui você deve por uma breve descrição sobre o projeto e sua finalidade.

Status do Projeto : Terminado / Em desenvolvimento / Suspenso

Deixe um ou dois badges com as frameworks ou linguagens utilizadas

Tabela de Conteúdo

Faça um índice com links internos para todos os tópicos seguintes.

1. Tecnologias utilizadas
2. Instalação
3. Configuração
4. Uso
5. Testes
6. Arquitetura
7. Autores

Tecnologias utilizadas

Essas são as frameworks e ferramentas que você precisará instalar para desenvolver esse projeto:

• Exemplo 1, versão 1
• Exemplo 2

Outras tecnologias interessantes que foram implementadas:

• Biblioteca X
• API Y

Instalação

Coloque aqui o passo a passo da instalação do projeto. Seja o mais claro e sucinto possível.

Caso precise rodar um comando no terminal, utilize a seguinte notação:

$ Digite seu comando aqui

Configuração

Coloque aqui o passo a passo da configuração do projeto. Seja o mais claro e sucinto possível.

Caso precise rodar um comando no terminal, utilize a seguinte notação:

$ Digite seu comando aqui

Uso

Explique como rodar o projeto a partir do terminal.

Para escrever os comandos utilizados no terminal, utilize a seguinte notação:

$ Digite seu comando aqui

Testes

Se o projeto possuir testes, coloque aqui o passo a passo para rodá-los. Seja o mais claro e sucinto possível.

Caso precise rodar um comando no terminal, utilize a seguinte notação:

$ Digite seu comando aqui

Arquitetura

Nesse tópico você deve por os links para documentações que tenham sido feitas quanto a arquitetura do projeto, incluindo porém não limitado a:

• Documentações sobre a concepção do projeto e design thinking (se tiver sido feita pela EJCM)
• Link para o Trello do projeto
• Link da prototipagem no figma (se ela tiver sido feita pela EJCM)
• Link para uma imagem da modelagem do banco de dados

Autores

Período: (1° Lote/ 2° Lote/ 3° Lote/ Suporte)

• Gerente - Nome
• Tech Lead - Nome
• Dev Front-end - Nome
• Dev Front-end - Nome
• Dev Back-end - Nome
   

Período: (1° Lote/ 2° Lote/ 3° Lote/ Suporte)

• Gerente - Nome
• Tech Lead - Nome
• Dev Front-end - Nome
• Dev Front-end - Nome
• Dev Back-end - Nome

Última atualização: xx/xx/xxxx

Aqui acaba o modelo do ReadMe. Recomendamos que ele seja criado junto com o repositório e atualizado, no mínimo, ao final de cada lote. Criado por Luciana Merege, Mileny Loyolla e Nayara Gomes, e atualizado em 12/04/2021