Skip to content

felipenlunkes/DoeTech

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DoeTech

DoeTech

O DoeTech é uma plataforma que visa criar uma interface entre empresas e pessoas físicas, interessadas em doar equipamentos eletrônicos que seriam descartados, e instituições sociais ou pessoas carentes que desejam receber esse tipo de equipamento. A proposta do DoeTech é diminuir a produção de lixo eletrônico enquanto favorece a reutilização de equipamentos eletrônicos por instituições de cunho social e pessoas de baixa renda.


Graduação em Análise e Desenvolvimento de Sistemas

Pontifícia Universidade Católica de Minas Gerais (PUC Minas)

Projeto: Desenvolvimento de uma aplicação interativa

1º semestre de 2025 (2025/2)


Integrantes


Orientador

  • Bernardo Jeunon de Alencar

Instruções de utilização

Execução remota (DoeTech hospedado)

O DoeTech está hospedado no serviço Azure, da Microsoft.

Acessar o DoeTech

Para acessar o DoeTech, clique aqui.

Execução local

Executar a aplicação backend localmente

Para executar a aplicação localmente, você precisa das seguintes dependências:

Caso tenha todas as dependências satisfeitas, siga os passos à seguir:

  • Abra o projeto em src/DoeTech/ com sua IDE de escolha;
  • Localize o arquivo docker-compose.yml. Ele será utilizado para subir um contêiner com uma imagem do MySQL e qualquer outra dependência necessária;

Agora, vamos subir as dependências, utilizando, no shell ou terminal de sua escolha:

docker compose up

Após, inicie a aplicação em modo Release/http. Uma janela do seu navegador padrão deve se abrir, mostrando o status da aplicação (Healthy, Unhealthy). Caso esteja como Unhealthy, alguma dependência não foi satisfeita. Verifique o log no console.

A aplicação será iniciada na porta 8080.

⚠️ A aplicação automaticamente irá executar as migrations, isto é, criar o schema no banco, bem como todas as tabelas. Nenhuma intervenção é necessária.

Importe o arquivo Postman.json, disponível dentro do diretório do projeto (src/DoeTech/Postman.json), no Postman, para acessar a API já implementada.

Lembre-se! Vários endpoints requerem autenticação via token. Veja em cada request no Postman ou nos controllers da aplicação. Caso alguma requisição não seja autorizada, há grande chance dela exigir um token. Para isso, faça login com um usuário criado por você. O endpoint de criação de usuário não requer autenticação via token. Lembre-se ainda que endpoints DELETE exigem que o usuário tenha role de administrador.

Instruções para finalizar a aplicação backend

Após encerrar a execução pela IDE, basta, no shell usado para executar o comando anterior, usar a combinação Ctrl-C. Caso tenha subido os contêiners com:

docker compose up -d

insira, no shell, no mesmo diretório do arquivo docker-compose.yml, inserir:

docker compose down

Executar a aplicação frontend localmente

Para executar o frontend, você precisa ter as seguintes dependências:

  • Aplicação backend sendo executada;
  • npm. Veja, na página do projeto, como instalar o npm em cada sistema operacional suportado;
  • ng. Veja, na página do projeto, como instalar o ng em cada sistema operacional suportado.

Após ter as dependências necessárias instaladas, navegue, no terminal, até src/DoeTech-frontend. À seguir, execute, no terminal:

npm i
ng serve

O comando npm i irá instalar todas as dependências necessárias para a execução da aplicação. Já o comando ng serve irá iniciar a execução da aplicação frontend desenvolvida em Angular.

O ng irá fornecer o endereço local para acesso à aplicação.

Instruções para finalizar a aplicação frontend

No terminal aberto com a execução do comando ng serve, pressione a combinação Ctrl-C.


Documentação

  1. Documentação de Contexto
  2. Especificação do Projeto
  3. Metodologia
  4. Projeto de Interface
  5. Arquitetura da Solução
  6. Template Padrão da Aplicação
  7. Programação de Funcionalidades
  8. Plano de Testes de Software
  9. Registro de Testes de Software
  10. Plano de Testes de Usabilidade
  11. Registro de Testes de Usabilidade
  12. Apresentação do Projeto
  13. Referências

Código

  • Código Fonte

  • Apresentação

  • Apresentação da solução