EducaMinas

---

---

Para melhor divisão e organização, o EducaMinas está dividido em dois repositórios.

Você está no Frontend. Acesse também:

• 🤖 Backend

---

O EducaMinas é um projeto desenvolvido na disciplina Métodos de Desenvolvimento de Software (MDS) ofertada no curso de Engenharia de Software na Universidade de Brasília (UnB), que visa reunir em um único local dados sobre a educação no estado de Minas Gerais, utilizando informações extraídas da pesquisa educacional realizada pelo INEP. A plataforma permite diferentes interpretações dos dados, com ênfase no aspecto social do ensino mineiro.

O projeto é um software livre e está sob a licença MIT.

---

🗒️ Sumário

• 🚩 EducaMinas
  • 🗒️ Sumário
  • 🏁 Início
    • 🏞️ Ambiente e Pré-requisitos
    • 📲 Instalação
    • ⚙️ Execução
  • 🛠️ Guia de contribuição
  • 📒 Documentação e muito mais!
  • 🏛️ Arquitetura
  • 📆 Board
  • 🖼️ Protótipo
  • 🧑🏽‍💻 Desenvolvedores

---

🏁 Início

Siga os passos abaixo para executar o frontend do EducaMinas:

🏞️ Ambiente e Pré-requisitos

Para rodar o projeto é fundamental ter algumas dependências globais:

• Node
• Python

Para visualizar versões, links e as instruções completas de configuração do ambiente: Ambiente e Pré-requisitos

📲 Instalação

Após configurar o Ambiente e Pré-requisitos, em um diretório de sua máquina, abra o terminal e execute:

git clone https://github.com/unb-mds/2024-1-EducaMinas-frontend.git

Com o repositório do frontend devidamente clonado, você terá acesso à aplicação Next.js e à documentação MkDocs:

Next.js

Navegue até o diretório raiz do repositório clonado:

cd 2024-1-EducaMinas-frontend

Em seguida instale as dependências do EducaMinas:

npm install

MkDocs

Navegue até o diretório docs localizado dentro da raiz:

cd docs

Instale as dependências da Documentação do EducaMinas:

pip install mkdocs mkdocs-material

⚙️ Execução

Next.js

Para executar a aplicação Next em sua máquina, execute no diretório raiz:

npm run dev

O servidor será inicializado e estará disponível na porta 3000 do localhost:

http://localhost:3000/

Demais comandos para execução de testes, builds e linter podem ser encontrados na guia scripts do arquivo package.json na pasta raiz.

No arquivo .env na raiz, é possível alternar a conexão com a API, por padrão, a conexão é feita com a API em produção, mas se você estiver executando localmente o backend, pode alternar para a url disponível com localhost.

MkDocs

Para executar a aplicação MkDocs em sua máquina, navegue até a pasta docs:

cd docs

Inicialize:

mkdocs serve

O servidor será inicializado e estará disponível em:

http://127.0.0.1:8000/

---

🛠️ Guia de contribuição

Para acessar o guia completo de contribuição: Guia de Contribuição

Nele, você encontra as respostas para as seguintes questões:

• Relatar um problema
• Implementar uma funcionalidade:
  • Clone
  • Dependências
  • Branches
  • Execução
  • Commits
  • Pull Requests
  • Revisão e Merge

---

📒 Documentação e muito mais!

Para acessar a documentação completa: Documentação EducaMinas

Nela, você encontra os seguintes tópicos:

• Início
• Sprints
• Projeto:
  • Personas
  • StoryMap
  • Requisitos
  • EAP
  • API
  • Arquitetura e Tecnologias
  • Protótipo
• Como contribuir:
  • Ambiente de desenvolvimento
  • Primeiros passos - frotend
  • Primeiros passos - backend
• Sobre

---

🏛️ Arquitetura

Confira a visualização geral da arquitetura do EducaMinas:

---

📆 Board

Acesse nosso Board no GitHub e acompanhe o desenvolvimento dos dois repositórios simultâneamente: Board EducaMinas

---

🖼️ Protótipo

Visualize nosso protótipo diretamente no FIGMA: Protótipo EducaMinas

---

🧑🏽‍💻 Desenvolvedores