Skip to content

ForUnB é um projeto com objetivo de auxiliar a monitoria para os alunos da UnB por meio de um fórum de dúvidas.

License

Notifications You must be signed in to change notification settings

unb-mds/2024-1-forUnB

Repository files navigation

License: MIT Quality Gate Status Coverage GitHub issues GitHub contributors

Python version Django version

O ForUnB é um projeto da disciplina Métodos de Desenvolvimento de Software, que tem como objetivo incentivar os alunos da Universidade de Brasília, campus Gama (UnB), a tirar dúvidas sobre qualquer matéria por meio de um fórum.

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

📝 Sumário

✨ Início

Você pode clonar o repositório do projeto com o seguinte comando:

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

📋 Pré-requisitos

Para rodar o projeto, você precisa instalar as dependências globais, que são:

💻 Ambiente

Para configurar o ambiente basta seguir este script na pasta principal do projeto.

# Cria um ambiente virtual Python e instala as dependências do projeto:
python3 -m venv .venv

# Com o ambiente virtual criado, ative-o:
source .venv/bin/activate

No Windows:

Para ativiar o ambiente basta

.venv\Scripts\activate

Quando o ambiente virtual estiver ativado, você verá (venv) antes do prompt de comando, indicando que o ambiente virtual está em uso.

📁 Dependências do projeto

# Faça a instalação das dependências do projeto:
make install

# Instale as dependências do projeto:
make config

Observação: O primeiro comando irá criar um arquivo chamado .env na raiz do projeto, que contém as variáveis de ambiente necessárias para rodar o projeto. O segundo comando irá instalar as dependências do projeto.

💾 Execução

Para executar o projeto em ambiente local, você pode entrar na pasta onde se encontra o arquivo manage.py e rodar os seguintes comandos:

# Entrar na pasta forunb/
cd forunb/

# Crie as migrações
python3 manage.py makemigrations

# Aplique as migrações
python3 manage.py migrate

🧹 Scraping SIGAA

Para carregar os dados do SIGAA, você pode rodar o seguinte comando:

# Rode o comando para carregar os dados do SIGAA
python3 manage.py scraping_sigaa

Para visualizar o projeto, basta utilizar este comando:

# Rode o servidor local
python3 manage.py runserver

📚 Documentação

Documentação do projeto pode ser acessada aqui.

🛠️ Protótipos

Protótipo de baixa fidelidade

  • Para acesar clique aqui.

Protótipo de alta fidelidade

  • Para acesar clique aqui.

✨ User Story Mapping

Miro

  • Para acessar clique aqui.

👥 Equipe de Desenvolvimento