Skip to content

The-Bugger-Ducks/help-duck-solution-center

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Microsserviço para manipulação de problemas e soluções

Esta API, que permite o gerenciamento de chamados, foi desenvolvida visando sua utilização no projeto "Help Duck" (mais informações vide este link).

Aplicação desenvolvida por alunos do 3º semestre do tecnólogo em Desenvolvimento de Software Multiplataforma, na FATEC Profº Jessen Vidal - São José dos Campos, SP 🚀

🛠️ Tecnologias

As seguintes tecnologias e ferramentas foram utilizadas neste projeto: Java, Spring, MongoDB, Docker, Insomnia, Heroku

⚙️ Como utilizar

Para consumir esta API, é preciso seguir o passo a passo abaixo ou utilizar a URL do serviço em nuvem (através deste link: https://help-duck-solution-center.herokuapp.com/).

  • Tutorial para rodar o projeto

No arquivo application-dev.properties, complete a variavel "spring.data.mongodb.uri" com a URI que o mongo disponibiliza ao logar na plataforma do MongoDB (Deployment -> Database -> connect -> connect your application). Se for localhost, utilize suas credenciais no formato da URI ( mongodb://:@localhost/ ):

Print do mongoDB atlas connect URI

image

spring.data.mongodb.uri=mongodb+srv://<username>:<password>@cluster0.rpjin.mongodb.net/myFirstDatabase?retryWrites=true&w=majority

Para prosseguir, é preciso que todas as ferramentas necessárias estejam devidamente instaladas (Java, Git, MongoDb...). Para conferir a instalação delas, acesse este tutorial. Após os downloads, baixe ou clone este repositório pelo terminal seguindo passo a passo descrito abaixo:

# Baixe este repositório ou clone pelo Git usando o comando:
$ git clone https://github.com/The-Bugger-Ducks/help-duck-solution-center.git

# Acesse a pasta do projeto
$ cd help-duck-solution-center

# Abra o projeto utilizando sua IDE preferida (Eclipse, VS Code, IntelliJ, etc.), espere o Maven carregar as dependências do projeto (são listadas no arquivo pom.xml) e execute!

O servidor inciará localmente na porta 8081. Use o Insomnia para simular requisições e respostas das rotas (pelo link https://localhost:8081) ou utilize o projeto fron-end do "Help Duck" para executar as funcionalidades da aplicação (acesse o repositório por este link).

🛤️ Rotas disponíveis

Tipo Rota Ação


Controle de soluções de chamados
/solutions/ Listagem de soluções
/solutions/ticket/{ticketId} Listagem de soluções por id de um chamado
/solutions/{solutionId} Dados de uma solução específica
/solutions/create Cadastro de soluções
/solutions/update Alteração dos dados de uma solução
/solutions/delete/{solutionId} Exclusão de soluções
/solutions/vote Computa os votos de uma solução


Controle de problemas
/problems/ Listagem de problemas
/problems/{problemId} Dados de um problema específico
/problems/create Cadastro de problemas


Controle de soluções de problemas
/solution/ Listagem de soluções
/solution/{solutionId} Dados de uma solução específica
/solution/search/{searchTitle} Busca soluções por palavra chave
/solution/create Cadastro de nova solução

Explicação da estrutura das pastas

Pasta Definição
📂 main/ .../ Arquivos com o código fonte do projeto
📂 main/ .../ config Configuração de cors, csrf, etc
📂 main/ .../ controller Arquivos com os métodos de requisição das rotas
📂 main/ .../ entity Arquivos com funções mais especificas, ex: atualizador, adicionador de links para HATEOAS, etc
📂 main/ .../ enums Arquivos de padronização de entrada para campos específicos no banco de dados
📂 main/ .../ repository Arquivo para utilização de CRUD de entidades (collection - mongodb) do projeto
📄 main/ .../ HelpduckSolutionCenterApplication.java Arquivo principal do projeto
📂 main/ resources/ Arquivos para configurações globais do projeto (ex: credenciais em banco de dados)
📄 docker-compose Arquivo usado para "conteinerizar" um banco mongo local
📄 pom.xml Arquivo usado gerenciar as dependencias do projeto com o Maven