README.md

Pismo

Acesse a API

Pré-requisitos

• Golang

OU (Recomendado)

• Docker
• Docker Compose*

Como rodar localmente?**

Baixe o repositório, entre no diretório e rode o comando:

make run/docker

Depois acesse a url

http://localhost:5001/

Como rodar os testes?**

make test/docker

Como fazer o deploy?

• Temos um Dockerfile para quando queremos levar essa aplicação para produção(Dockerfile.production). Ela é diferente da desnvolvimento porque ela usa multi-stage build para deixar a imagem bem menor com um S.O. mais leve e apenas o binário da aplicação para rodar.

• No caso estou fazendo o deploy no Heroku. Então só "commitar na master" ou apertar o botão de deploy:

  • 

*Para Facilitar | **Com Docker + Docker Compose

Outras informações

• Usei libs(packages) padrões ao maximo, tentando extrair tudo da linguagem Go.

• Nos testes usei Table Driven Tests.

• Para me organizar gosto de usar o Github Project pois ele é bem fácil de usar e tem um ótimo suporte a Markdown. Criei um board bem simples aqui.

• Tambem separei em milestones por nivel, aqui

• Para organizar o código gosto do Gitflow por ser uma forma “padrão” de trabalhar com git e se da muito bem com a recomendação SEMVER.

• Um CI bem simples foi configurado no TravisCI para pegar Pushs e PRs. A badge fica bem intuitiva no README ().