Para melhor divisão e organização, o EducaMinas está dividido em dois repositórios.
Você está no Frontend. Acesse também:
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.
Siga os passos abaixo para executar o frontend do EducaMinas:
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
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.gitCom o repositório do frontend devidamente clonado, você terá acesso à aplicação Next.js e à documentação MkDocs:
Navegue até o diretório raiz do repositório clonado:
cd 2024-1-EducaMinas-frontendEm seguida instale as dependências do EducaMinas:
npm installNavegue até o diretório docs localizado dentro da raiz:
cd docsInstale as dependências da Documentação do EducaMinas:
pip install mkdocs mkdocs-materialPara executar a aplicação Next em sua máquina, execute no diretório raiz:
npm run devO 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.
Para executar a aplicação MkDocs em sua máquina, navegue até a pasta docs:
cd docsInicialize:
mkdocs serveO servidor será inicializado e estará disponível em:
http://127.0.0.1:8000/Para acessar o guia completo de contribuição: Guia de Contribuição
Nele, você encontra as respostas para as seguintes questões:
Para acessar a documentação completa: Documentação EducaMinas
Nela, você encontra os seguintes tópicos:
Confira a visualização geral da arquitetura do EducaMinas:
Acesse nosso Board no GitHub e acompanhe o desenvolvimento dos dois repositórios simultâneamente: Board EducaMinas
Visualize nosso protótipo diretamente no FIGMA: Protótipo EducaMinas
|
|
|
|
|
|