Skip to content

Latest commit

 

History

75 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eDoe API

Sobre a API

API REST para o gerenciamento de doações para universitários no Campus IV da UFPB.

🔰 Tabela de conteúdo

⚡ Tecnologias envolvidas

  • Java 11
  • Spring Boot 2.5.6
  • H2 Database
  • Swagger 3.0
  • Maven

✅ Casos de Uso

  • US 1 - Cadastro de usuários
  • US 2 - Configurar papéis de usuários
  • US 3 - Autenticar usuários no sistema
  • US 4 - Cadastro de itens a serem doados
  • US 5 - Gerar listagens dos itens a serem doados
  • US 6 - Cadastro de itens necessários
  • US 7 - Gerar listagens dos itens necessários
  • US 8 - Identificar possíveis matches de itens para doação e itens necessários
  • US 9 - Realizar doações e manter o histórico de doações
  • US 10 - Listar doações realizadas

✅ Requisitos não funcionais

  • Um vídeo demonstração de no máximo 3 minutos da aplicação em execução.
  • Uma versão operacional implantada (deployed) do sistema, será optativo, mas altamente desejável.
  • Todos os dados desta aplicação devem persistir em um banco de dados.
  • Autenticação/autorização via JWT - JSON Web Token. O período de validade de um token deve ser definido pelo grupo e justificado no README.md.
  • Manter repositório privado no github para backend . Os repositórios devem ser compartilhados com a professora (raquelvl).
  • Os repositórios devem ser privados e compartilhados exclusivamente com os membros do grupo (além da professora). O grupo será penalizado se houver compartilhamento irregular em qualquer momento do desenvolvimento.
  • Um readme.md no repositório do backend explicando sucintamente a API e informando os seguintes links: documentação swagger da API em operação e link para o backend implantado em operação (opcional).
  • Para quem implantar no heroku: a aplicação operacional já deve ter algumas campanhas e usuários criados previamente. No readme.md do repositório devem ser informadas as credenciais de pelo menos um usuário fictício já criado.

✅ Status do Projeto

🚧 Em construção 🚧

✅ Execução do projeto

  • Para executar o proejto basta entrar no diretório api/ e rodar o comando mvn spring-boot:run.
  • Obs.: É necessário ter o Maven instalado no SO.

📖 Documentação da API

http://localhost:8080/v1/api/swagger-ui/ (Localmente)

🎬 Demonstração em vídeo

Vídeo curto (~ 3 min): https://youtu.be/9dSCThgUC64
Vídeo longo (mais detalhado por caso de uso): https://youtu.be/hu9gewj9d4k

About

API para o sistema de doação eDoe

Topics

Resources

Stars

1 star

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages