customer-api

Descrição

API de clientes, com suporte às seguintes operações:

  • Salvar um novo cliente;
  • Atualizar um cliente;
  • Recuperar um cliente por ID;

Como executar o projeto localmente:

  1. Primeiro, precisamos criar um arquivo (.env) para carregar nossas variáveis de ambiente. Você pode usar o seguinte comando para copiar as variáveis do .env.example:
cp .env.example .env
  1. Agora, basta criarmos e iniciarmos os containers docker. Para isso, podemos executar o seguinte comando:
docker-compose up
  1. Pronto! Caso você não tenha alterado o valor da variável API_PORT, no .env, o projeto já deve estar disponível em http://localhost:3000/. Você pode tentar acessar a rota de health check (http://localhost:3000/health), bem como a documentação (Swagger) do projeto (http://localhost:3000/docs).

Processo de deploy

Levando em consideração o porte do projeto, assim como questões de custos, seguimos um caminho mais simples para o deploy da aplicação. Em uma instância Amazon EC2, instalamos as ferramentas necessárias (git, docker, docker-compose) e então seguimos os passos descritos na seção acima. Por fim, configuramos as regras, nos grupos de segurança, para permitir o acesso externo à nossa aplicação. Aqui, você consegue acessar a documentação da aplicação.