O projeto lista todas as cidades dentro de um estado brasileiro
É altamente recomendado que você tenhas as ferramentas docker e docker-compose para executar o projeto, assim é possível utilizar a ferramenta Sail (que nada mais é do que um arquivo docker-compose.yml e um script sail que é armazenado na raiz do projeto) do próprio Laravel.
O comando Sail nos disponibiliza uma CLI com diversos métodos convenientes pra interagir com os contêiners Docker definidos pelo arquivo docker-compose.yml, além de prover um acesso fácil ao artisan, composer e muito mais! O Sail atualmente está disponível para as plataformas macOS, Linux e Windows (através do WSL2).
A instalação para cada sistema operacional varia, portanto abaixo está um link da própria documentação do Laravel com mais instruções para a instalação das dependências do projeto.
https://laravel.com/docs/10.x/installation#docker-installation-using-sail
(Ainda) Não foram realizadas tratativas de CORS para as requisções, logo, muito provavelmente ocasionará em erros caso rode o projeto via composer.
Pré-requisitos:
- Certifique-se de ter o PHP na versão 8 ou mais recente instalado em sua máquina.
- Instale o Composer
No terminal, navegue para o diretório do projeto e digite:
php artisan serveO projeto conta com três endpoints:
Caso for rodar o projeto através do Laravel Sail, O valor de
$baseUrlprovavelmente será http://localhost:80/api
$statedeve ser asiglado Estado, não o nome.$pagedeve ser um inteiro que simboliza a página atual, o query parameterpageé opcional.
{$baseUrl}/v1/cities/{$state}?page={$page}{$baseUrl}/v1/states (primariamente para fins de testes){$baseUrl}/documentation
Realizei o deployment da aplicação na plataforma Fly.io e você pode acessar através do link abaixo