Skip to content

robsonalvz/simple-map-api

Repository files navigation

Build Status

Desafio - Simple Map API

Api desenvolvida para gravar o histórico de rotas para a aplicação SimpleMap.

Stacks utilizadas

  • Yarn (Para gerenciamento de dependêncis)
  • Nodejs e Express (Server)
  • MongoDB Atlas (Database)
  • Youch (Para padronização de erros)
  • Docker (Aplicação em container)
  • PM2 (Para gerenciamento de processos em tempo de execução JS)
  • Travis CI (Para integração contínua e testes automatizados)

Arquitetura

  • A arquitetura do serviço foi construida em módulos para garantir a produtividade caso o sistema ganhe novas features.
  • Fácil manutenção e entendimento, garantindo a independência de módulos.
  • Divisão de controllers, models , routes e validators.
  • Fácil adaptação a mudanças.
  • Generic Exception Handler, para faciltar a captura de erros.
  • Validators para garantir que o corpo da requisição venha do formato correto.

Os módulos são divididos da seguinte forma:

  • Módulo1
    • routes
    • controllers
    • validators
    • models
  • Módulo2 ....

Instalação Local

Clonagem do diretório:

git clone https://github.com/robsonalvz/simple-map-api

Instale as dependencias do projeto

yarn install

Configuração

Criação do arquivo de configuração local, altere as configurações da porta da api e do mongo atlas de acordo com suas credenciais.

cp .env.example .env

Rodando o projeto

yarn start

Rodando o projeto com o Docker

Fique a vontade para colocar a porta desejada, e o nome desejado para a imagem/container.

docker build -t simple-map-api .
docker run --name simple-map-api -p 6000:5000 simple-map-api

About

Api para a aplicação SimpleMap

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published