README.md 2.62 KB
Newer Older
João Denis Rodrigues's avatar
João Denis Rodrigues committed
1
# ADEGA
2 3


João Denis Rodrigues's avatar
João Denis Rodrigues committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
Este software faz parte de um projeto do PET Computação UFPR para 
análise de dados dos cursos de graduação da UFPR. Veja a [wiki](http://gitlab.c3sl.ufpr.br/pet/adega/wikis/home).


## Versão
0.0.0



## Obtendo os códigos


Os códigos fonte do projeto estão disponíveis publicamente no [gitlab]
(gitlab.c3sl.ufpr.br/pet/adega).

E podem ser clonado com o comando

```bash
22
$ git clone git@gitlab.c3sl.ufpr.br:pet/A.D.E.G.A.git
João Denis Rodrigues's avatar
João Denis Rodrigues committed
23 24 25 26 27 28 29
```


## Instalação e dependências


```bash
Jomaro Rodrigues's avatar
Jomaro Rodrigues committed
30 31 32
sudo make install
make install-user
pipenv install --dev
João Denis Rodrigues's avatar
João Denis Rodrigues committed
33 34
```

Jomaro Rodrigues's avatar
Jomaro Rodrigues committed
35 36 37 38 39 40 41
Criar o banco de dados postgres

```
sudo -u postgres psql < postgres/create.sql
```


João Denis Rodrigues's avatar
João Denis Rodrigues committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
se você possui o arquivo do banco de dados compartilhado internamente pelos 
desenvolvedores do projeto coloque-o na home do projeto, ele vem com um usuário 
`pet` com senha `pet` pré-configurado para testes.


se você não possui o arquivo rode

```bash
python manage.py migrate
python manage.py createsuperuser
```


## Executando o projeto

57
Por padrão ele irá rodar no 127.0.0.1:8000, ative o virtualenv antes
João Denis Rodrigues's avatar
João Denis Rodrigues committed
58
```bash
59
pipenv shell
João Denis Rodrigues's avatar
João Denis Rodrigues committed
60 61 62 63 64
python manage.py runserver
```

Se estiver usando o cloud9 use o ip e a porta que ele libera, assim:
```bash
65
pipenv shell
João Denis Rodrigues's avatar
João Denis Rodrigues committed
66 67
python manage.py runserver $IP:$PORT
```
68

João Denis Rodrigues's avatar
João Denis Rodrigues committed
69 70
Então acesse pela url fornecida

71 72
Ao sair do projeto execute `exit` para sair do virtualenv e evitar polui-lo

João Denis Rodrigues's avatar
João Denis Rodrigues committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
## Transformando o seu usuário em um professor

Após você logar no sistema com o seu super usuário você terá acesso ao `URL_DO_SITE/admin`, graças ao [Django admin](https://docs.djangoproject.com/en/1.10/ref/contrib/admin/) nesta tela você é capaz de gerenciar os dados salvos nas models do projeto.   
Para transformar o seu usuário em professor basta clicar em `professor`e então selecionar o seu usuário e o curso. Agora se você voltar para a página inicial do sistema você deve ver uma listagem dos seus cursos. 


## Gerar diagrama do projeto

Basta executar:
```bash
python manage.py graph_models -a -o diagrama.png
```

### Entendendo as dependências do projeto:

* [Django](https://www.djangoproject.com/) - Framework base. Trata a requisição dos clientes e chama as devidas rotinas.
* [Bootstrap](http://getbootstrap.com/) - Framework css. Usamos os seus componentes para deixar as telas bonitas
* [Charts.js](http://www.chartjs.org/) - Biblioteca javascript para desenhar gráficos.
* [Pandas](http://pandas.pydata.org/) - usada para importação dos dados
* [django-extensions](https://django-extensions.readthedocs.io/en/latest/) - Várias extensões para o django. Estamos usando para gerar o diagrama do projeto.


## Contato


Email - pet@inf.ufpr.br

Facebook - pt-br.facebook.com/petcompufpr