AcheiUnB

AcheiUnB é um projeto desenvolvido para facilitar a vida dos estudantes da Universidade de Brasília (UnB) na busca e recuperação de itens perdidos. A plataforma permite que os alunos registrem e encontrem objetos, facilitando o contato entre quem perdeu e encontrou o item. O objetivo é reduzir a dependência de grupos de mensagens e proporcionar um sistema mais organizado e acessível para achados e perdidos.

📝 Sumário

• AcheiUnB
  • 📝 Sumário
  • 👥 Equipe
  • ✨ Início
  • 📋 Pré-requisitos
  • 💻 Ambiente
  • 📁 Dependências do Projeto
  • 💾 Execução
    • Observações do Docker
  • ✅ Autenticação com o Google OAuth
  • 📥 Atualização do Banco de Dados
  • 🖱️ Acesso aos Serviços
  • 📍 Migrations
  • 📚 Documentação
  • 📎 Extra
  • Story Map e Activity Flow
  • Arquitetura
  • Protótipo

👥 Equipe

Ana Elisa Marques	Davi Camilo Menezes	Euller Júlio da Silva	Leonardo Ramiro Alves de Oliveira

Pedro Everton de Paula	Pedro Henrique Martins Silva	Tiago Antunes Balieiro

✨ Início

Clone o repositório do projeto usando o seguinte comando:

git clone https://github.com/unb-achei/2024-2-AcheiUnB.git

📋 Pré-requisitos

Para rodar o projeto, você precisa das seguintes ferramentas:

• Python v3.11.6 e Pip v22.0.2 ou superior

💻 Ambiente

Para configurar o ambiente, rode o seguinte script:

make config

📁 Dependências do Projeto

Para instalar as dependências, siga os passos abaixo:

# Crie um ambiente virtual para Python
python3 -m venv api/env

# Ative o ambiente virtual
source api/env/bin/activate

# Instale os pacotes do Python e do Node
make install

💾 Execução

Para iniciar o projeto, use o comando:

docker compose up

Observações do Docker

• Para rodar o projeto em segundo plano:

  docker compose up -d

• Caso precise reconstruir a imagem do Docker:

  docker compose up --build

• Se for necessário deletar os volumes:

  docker compose down -v

✅ Autenticação com o Google OAuth

Para ativar o login com Google, substitua your_client_id no arquivo web/.env.local pelo Client ID do seu projeto no Google Cloud:

1. Crie um projeto no Google Cloud.
2. Vá para "Credenciais" e selecione "Criar credenciais" > "ID do cliente OAuth".
3. Defina como tipo de aplicativo "Aplicativo Web" e adicione http://localhost:3000 como origem autorizada e URI de redirecionamento.
4. Copie o Client ID e substitua em web/.env.local.

Após essa configuração:

1. No Google Cloud, vá para "Tela de Consentimento OAuth".
2. Adicione o seu e-mail como usuário de teste e salve.

📥 Atualização do Banco de Dados

Os dados são obtidos por meio de scraping do site da UnB e precisam ser atualizados periodicamente. Para atualizar, use:

make updatedb-all

ou, de forma equivalente:

docker exec django-api python3 ./manage.py updatedb -a

🖱️ Acesso aos Serviços

📍 Migrations

Sempre que alterar o modelo de dados, crie novas migrations com os comandos:

make makemigrations  # Cria as migrations
make migrate         # Executa as migrations

📚 Documentação

Acesse a documentação completa do projeto aqui.

📎 Extra

Story Map e Activity Flow

Para acessar o Story Map e Activity Flow, clique aqui.

Arquitetura

A descrição da arquitetura do projeto pode ser encontrada aqui.

Protótipo

O protótipo da plataforma está disponível aqui.

AcheiUnB é um software livre, disponível sob a licença MIT.