Rick and Morty Travels

Sistema de criação de planos de viagem baseados nas localizações presentes na API pública Rick and Morty como proposto pela Milenio Capital no desafio de processo seletivo.

Funções

• Criar plano de viagem
• Editar plano de viagem
• Deletar plano de viagem
• Ver planos de viagem
• Ver locais disponíveis para viagem (EXTRA)

Documentação da API

Esta é apenas uma documentação dos endpoints, para saber mais detalhes sobre parâmetros, existe uma documentação detalhada ao rodar o servidor no endpoint /docs

Ver planos de viagem

  GET /travel_plans

• optimize=true - Otimiza o plano de viagem
• expand=true - Expande o plano de viagem

Ver um plano de viagem

  GET /travel_plans/:id

• optimize=true - Otimiza o plano de viagem
• expand=true - Expande o plano de viagem

Criar plano de viagem

  POST /travel_plans/:id

| Parâmetro | Tipo | Exemplo | | :-------- | :------- | :-------------------------------- | | travel_stops | Array | [1,2,3] |

Editar plano

  PUT /travel_plans/:id

| Parâmetro | Tipo | Exemplo | | :-------- | :------- | :-------------------------------- | | travel_stops | Array | [3,2,1] |

Deletar plano

  DELETE /travel_plans/:id

Ver locais disponíveis (EXTRA)

  GET /travel_stops

Como iniciar localmente

Execute os comandos na pasta do projeto

• Normal

  crystal run src/app.cr

• Com docker

  docker-compose build
  docker-compose up

Testes

Para executar testes basta usar o seguinte comando na pasta do projeto

  crystal spec

Frontend

Para consumir a API, foi desenvolvido um frontend totalmente responsivo que é capaz de consumir todos endpoints de forma totalmente intuitiva.