joaoseidel / message

A simple message scheduler API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Message Schuduler

A simple message scheduler application

Conteudos

  1. Sobre o projeto
  2. Comecando
  3. Usage
  4. License
  5. Contato
  6. Acknowledgements

Sobre o projeto

A arquitetura/estrutura do projeto foi escrita baseada no conceito de arquitetura Hexagonal, no modelo proposto por Tom Hombergs, que pode ser consultada em Hexagonal Architecture with Java and Spring.

A API do projeto foi desenvolvida no modelo RESTFul e documentada com o Swagger.

A suite de testes ficou divida em testes unitarios com Mockito e JUnit 5, e os testes integrados rodam utilizando o Testcontainers.

Construido com

Comecando

Para obter uma cópia local, siga estas etapas simples.

Pre-requisitos

  • Maven 3.6
  • Java 11
  • Docker

Instalacao

  1. Clone o repositorio
    $ git clone https://github.com/joaoseidel/message.git
  2. Instalando com maven
    $ mvn clean install

Uso

  1. Rodando o projeto com docker compose
$ docker compose up -d
  1. Apos a conclusao do comando acima, pode-se acessar a pagina do SwaggerUI acessando a seguinte URL: http://localhost:8080/swagger-ui.html

License

Distributed under the MIT License. See LICENSE for more information.

Contato

Joao Seidel - @website

Project Link: https://github.com/joaoseidel/message

Acknowledgements

About

A simple message scheduler API

License:MIT License


Languages

Language:Java 99.8%Language:Dockerfile 0.2%