fga-eps-mds / 2021.2-INDICAA

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.

https://fga-eps-mds.github.io/2021.2-INDICAA-Wiki/

GNU General Public License v3.0

8 stars 7 forks source link

:bug: Correção de Arquivos do Back-End #150

Closed gabrielm2q closed 2 years ago

gabrielm2q commented 2 years ago

Descreva o bug Em reunião com o monitor, foram apontadas algumas correções a serem feitas para que o Deploy da aplicação no Heroku seja realizado. Dentre elas, temos a correção do nome do Dockerfile, além de algumas pequenas correções e adições no settings.py e nos requirements.txt.

Passo a passo para a reprodução do bug O "bug" foi encontrado durante uma tentativa de deploy da aplicação no Heroku.

Comportamento esperado É esperado que a aplicação seja executada corretamente em máquina local e, ao mesmo tempo, em eventual deploy no Heroku.

Tarefas

[x] Corrigir nome do Dockerfile
[x] Corrigir arquivo "settings.py"
[x] Adicionar dependências ao arquivo "requirements.txt"

Critérios de aceitação

[x] O projeto deve ser executado normalmente em máquina local
[x] O projeto deve ser passível de deploy no Heroku
[x] Todas as alterações devem ser justificadas na issue
[x] As alterações devem ser revisadas

gabrielm2q commented 2 years ago

Mudança no Dockerfile

Após reunião com o monitor, foi identificado que o arquivo "dockerfile" poderia ser um possível problema para a execução do projeto devido ao seu nome (com "d" minúsculo). Para todos os casos, foi alterado o nome para "Dockerfile" apenas para prevenir eventuais erros.

gabrielm2q commented 2 years ago

Mudança nos Requirements

Primeiramente, o "django-heroku" apresentava versão "==0.0.0". Para que seja usada a versão mais recente, não será especificada a versão usada.
Logo após, foram adicionadas as dependências "gunicorn" e "whitenoise" para que o deploy da API seja executado corretamente.

gabrielm2q commented 2 years ago

Mudanças no Arquivo Settings

Após reunião com monitor, foram executadas as seguintes alterações no arquivo "settings.py":

Na lista "MIDDLEWARE", foi adicionado o WhiteNoise através do trecho: "whitenoise.middleware.WhiteNoiseMiddleware".

Ao final do arquivo, foram adicionados os seguintes comandos:

STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR,'static')
STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'

Todas as mudanças acima foram realizadas para solucionar eventuais problemas no deploy da API e podem ser justificadas na Documentação do WhiteNoise.

gabrielm2q commented 2 years ago

Execução Local

A execução local dos contêineres a partir do "docker-compose up" se deu conforme o esperado, sem quaisquer erros pertinentes a essa bugfix.

Deploy

O deploy da API foi realizado conforme o esperado, sendo possível a criação de um banco de dados (ainda sem os dados do scraping). O deploy pode ser encontrado em: https://indicaa-api-unb.herokuapp.com

gabrielm2q commented 2 years ago

Corrigidos todos os erros, essa issue pode ser revisada, tendo em vista que a execução local (docker-compose up) e o deploy (https://indicaa-api-unb.herokuapp.com) devem ser conferidos.

Não é necessária a realização de outro deploy, apenas a conferência do deploy existente.

Quando realizada a review, já poderá ser executado o Pull Request.