squad-3-ad-java-softplan-1

Table of Contents

• Visão Geral
• Instalação
• Documentação
• Roadmap

Error Logger

Visão Geral:

Aplicação desenvolvida como requisito final da aceleração em Java promovida pela Codenation. O Objetivo da aplicação é basicamente a realização de uma API que seja capaz de armazenar erros em banco de dados relacional, criando-se os endpoints para serem consumidas pelo Frontend. Trata-se de uma aplicação Rest criada com Spring-boot e suas dependências, conforme pom.xml. A segurança da aplicação foi desenvolvida com utiização da JWT. Embora as aulas tenham sido lecionadas ensinando o padrão OAUTH2, como a empresa Softplan (patrocinadora do projeto) utiliza a abordagem JWT em suas aplicações, a equipe optou por este tipo de autenticação.

Instalação:

Requisitos:

• Java JDK
• Maven

Para instalar o projeto é necessária a realização dos seguintes passos:

1. Abra o terminal e digite na pasta raiz do projeto:

mvn install 

2. após isso digite:

cd target
java [nome do arquivo gerado]

Deploy do Projeto:

Requisitos:

• Docker

Para fazer o deploy pelo docker, realize os seguintes procedimentos:

1. Edite o arquivo '.env' que vai conter as variavéis de ambiente para sua aplicação

2. e então abra seu terminal na pasta raiz do projeto e execute:

docker-compose up

Pronto, sua aplicação já está funcionado.

Aqui você encontra mais sobre as releases do Error Logger no Docker.

O frontend se encontra disponível em: Error logger - React

Documentação:

A documentação do projeto foi realizada através do Swagger, e se encontra disponível em documentação

Roadmap:

• Autenticação no cadastro de usuários
• Permitir que o usuário altere sua senha de acesso
• Criar auditoria em usuários
• Criar perfis de usuários
• Continuous deploy
• Internacionalização das mensagens

HOME