https://github.com/codenation-dev/squad-3-ad-java-softplan-1
https://github.com/codenation-dev/squad-3-ad-java-softplan-1
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codenation-dev/squad-3-ad-java-softplan-1
- Owner: codenation-dev
- Created: 2019-09-19T16:57:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T16:35:02.000Z (almost 2 years ago)
- Last Synced: 2025-02-17T09:34:31.848Z (over 1 year ago)
- Language: Java
- Size: 435 KB
- Stars: 7
- Watchers: 6
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# squad-3-ad-java-softplan-1
## Table of Contents
- [Visão Geral](#visão-geral)
- [Instalação](#instalação)
- [Documentação](#documentação)
- [Roadmap](#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](https://hub.docker.com/r/squadjoaquina/errorlogger/) no Docker.
O frontend se encontra disponível em: [Error logger - React](https://github.com/FelipeCooper/squad-3-ad-java-softplan-1-react)
#### Documentação:
A documentação do projeto foi realizada através do Swagger, e se encontra disponível em [documentação](https://errorlogcodenation.herokuapp.com/swagger-ui.html)
#### 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](#table-of-contents)