Skip to content

Este projeto tem como objetivo criar um software para a melhor visualização de informações relacionadas às matérias ofertadas no SIGAA, com o objetivo de melhorar o trabalho da secretaria na volta gradual as aulas.

License

Notifications You must be signed in to change notification settings

fga-eps-mds/2021.2-INDICAA

Repository files navigation



INDICAA é um projeto desenvolvido por alunos da matéria de Métodos de Desenvolvimento de Software da Universidade de Brasília - UnB com o objetivo de facilitar o acesso às informações apresentadas pelo site acadêmico SIGAA oferta.

Nós somos um projeto que visa a busca e a disponibilização visual de informações acadêmicas relevantes aos coordenadores da Universidade de Brasília - UnB, e também, possibilitar a pesquisa e a filtragem de dados por meio da interface do Metabase.

No contexto da pandemia, a gestão de espaços se tornou fundamental para o bom funcionamento da UnB. Nesse contexto, a equipe de coordenação voltou seus esforços para propiciar uma boa divisão das disciplinas e atividades no geral de acordo com o espaço existente. Para tal, a visualização da divisão dos espaços de acordo com os períodos do dia é essencial para uma melhor tomada de decisões pelos gestores, o que impactará diretamente a execução das atividades acadêmicas da universidade.

Utilizando a interface do Metabase, é possível visualizar os dashboards já criados pela equipe de desenvolvedores do projeto INDICAA, criar novos dashboards conforme necessidade de obtenção de dados mais específicos, visualizar os dados retirados do site SIGAA e armazenados no banco de dados INDICAA e também, filtrar os dados que estão sendo visualizados com base nas categorias disponíveis.

image

⌨️🔨 Linguagens e ferramentas utilizadas

📑 Releases previstas

🚀💾 Instalação e execução do projeto

🌎 Acesso ao projeto em sua versão de produção (na web)

🏭 Rodando o projeto em versão de desenvolvimento (localmente)

Instalação das tecnologias

🐋 Docker cli:

Confira se o docker está instalado em sua máquina.

docker version

O comando acima deve retornar uma mensagem com a versão do docker instalada em sua máquina. Caso o Docker não esteja instalado, visite a página oficial de instruções de instalação e faça o passo a passo descrito.

É recomendada a utilização de versões >= 20.10.14.

🐍 Python:

Verifique a versão instalada do python.

python --version

ou

python3 --version

Os comandos acima devem retornar algo como: Python 3.9.0 . Isso significa que o python está instalado e sua versão é a 3.9.0.

É recomendada a utilização de versões >= 3.9.x. Caso necessário, siga o passo a passo informado na página oficial de instruções de instalação.

Execução

🚀 GitHub Pages

Clonar este repositório:

git clone https://github.com/fga-eps-mds/2021.2-INDICAA-Wiki 

Entrar na pasta em que o clone está localizado:

cd 2021.2-INDICAA-Wiki

Instalar os pacotes mkdocs material e mkdocstrings

pip install mkdocs-material mkdocstrings

Rodar o gitpages localmente:

mkdocs serve

Agora, o git pages (versão de desenvolvimento) deve estar disponível em: http://127.0.0.1:6969/

🧭 API

Clonar o repositório INDICAA:

git clone https://github.com/fga-eps-mds/2021.2-INDICAA

Entrar na pasta em que o clone está localizado:

cd 2021.2-INDICAA

Com o docker instalado na sua máquina, rodar:

docker-compose up

A instrução acima rodará a aplicação do INDICAA, ou seja, criará um banco de dados POSTGRE, posteriormente é feito o scraping das informações obtidas através do SIGAA e, por fim, será hospedado o Metabase, a partir de uma imagem do Docker Hub.

A API deve estar disponível em: http://127.0.0.1:8000/

E o Banco de Dados POSTGRE deve estar disponível em: http://127.0.0.1:5432/

Obs.: Note que terá uma demora na execução e esse processo é totalmente normal.

📊 Metabase

O Metabase deve estar disponível em: http://127.0.0.1:3000/

Como é o primeiro acesso a imagem criada pelo Docker Hub, será necessário realizar uma configuração prévia, seguindo as etapas descritas na issue.

🤝 Contribuições

O projeto INDICAA é um projeto Open Source e de software livre desenvolvido por alunos da disciplina de Métodos de Desenvolvimento de software da UnB. Com isso, o projeto é de livre contribuição e reprodução. Vale apenas ressaltar que é necessário que sejam seguidas as regras de contribuição e o código de conduta do projeto.

🔐 Licença

Este projeto está licenciado sob os termos estabelecidos pela GNU General Public License v3.0.

About

Este projeto tem como objetivo criar um software para a melhor visualização de informações relacionadas às matérias ofertadas no SIGAA, com o objetivo de melhorar o trabalho da secretaria na volta gradual as aulas.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published