jj7ecno/template-readme

Repositório com template para README de projetos do Github.

Nome do Site

Slogan do Projeto. Fazer um texto curto sobre o que é o projeto.

---

🕵Sobre

Escrever de forma sucinta sobre o que é o seu projeto. Por exemplo, se você está fazendo uma Pokedéx pode escrever : Aplicação com intuito de criar uma pokedéx, site onde você pode ver os detalhes dos pokemóns e montar a sua equipe.

---

👩🏾Quem Faz

• COLOCAR O NOME DAS PESSOAS AUTORAS DO PROJETO
• PESSOA 1
• PESSOA 2
• PESSOA 3

---

🔠Conteúdos

• Sobre
• Quem Faz
• Status
• Objetivo do Projeto
• Requisitos de Funcionalidade
• Concepção do Projeto
• Link para Acessar
• Rodando o Projeto
• Sobre a Licença

---

🧭Status do Projeto

COLOCAR AQUI O STATUS DO PROJETO. ALÉM DISSO, VOCÊ PODE COLOCAR QUAL PARTE VOCÊ ESTÁ DESENVOLVENDO (ESTILIZAÇÃO, RESPONSIVIDADE, ETC...)

• ⏳ Fazendo
• 📥 Testando
• ⌛ Feito

---

🎯Objetivo do Projeto

Este é um projeto de Back-end | Front-end | Full-Stack , desenvolvido no bootcamp da Labenu, cujo o principal objetivo é estudar e compreender : COLOCAR AQUI QUAIS SÃO OS CONCEITOS E TECNOLOGIAS QUE VOCÊ ESTAVA FOCADO EM ESTUDAR, AO REALIZAR ESSE PROJETO.

EXEMPLO:

• Este é um projeto de Back-end , desenvolvido no bootcamp da Labenu, cujo o principal objetivo é estudar e compreender : Diferença entre banco de dados relacionais e não relacionais ; MySQL ; Criação de Query.

☑️Requisitos de Funcionalidade

• Funcionalidade 1
• Funcionalidade 2
• Funcionalidade 3
• Funcionalidade 4

Além das funcionalidades, aqui você pode por Prints e gifs do seu projeto, como ele funciona.

---

💡Concepção do Projeto

• Wireframe do Projeto: COLOCAR AQUI O WIREFRAME "ESBOÇO" DO PROJETO
• Link do Figma: COLOCAR AQUI O LINK DO FIGMA | LINK DO ADOBE XD | LINK DO WIREFRAME (FRONT-END)
• Modelagem do Banco de Dados : COLOCAR AQUI OS DIAGRAMAS DE MODELAGEM DO BANCO DE DADOS E EXPLICAR UM POUCO SOBRE .

EXEMPLO:

Para esse projeto são modelados três entidades : Estudante (STUDENT), Professor (TEACHER) e Turma(CLASS). Cada um com as seguintes caracteristicas :

→ Estudante - id, nome, email, data de nascimento e os principais hobbies;

→ Professor - id, nome, email, data de nascimento e todas as especialidades ;

→ Classe - id, nome, data de início, data de término, lista de professores responsáveis, uma lista de alunos e módulo atual em que a turma está.

---

🔗Link para Acessar

• Link do Surge: COLOCAR AQUI O LINK DO SURGE

---

🛰Rodando o Projeto

EXPLICAR AQUI O PASSO A PASSO PARA CONSEGUIR RODAR E ACESSAR O PROJETO.

Para Rodar o projeto, siga as seguintes etapas :

• COLOCAR A ETAPA 1
• COLOCAR A ETAPA 2
• COLOCAR A ETAPA 3

---

📝Sobre a Licença

Este projeto esta sobe a licença MIT.