Para rodar essa aplicação você precisará do PHP 7.4, Composer e MySQL. Além disso, são necessárias as extensões do PHP para utilizar o framework Laravel 8, você pode conferir elas aqui.
Após clonar o repositório para sua máquina, entre em seu diretório e instale as dependências usando o composer:
$ composer install
Depois disso, copie o arquivo .env.example
para .env
e gere a chave da aplicação:
$ cp .env.example .env
$ php artisan key:generate
Crie um banco de dados MySQL e insira os detalhes da conexão no arquivo .env
:
DB_DATABASE=example_database
DB_USERNAME=example_user
DB_PASSWORD=qwe123
Após isso, rode as migrations para inserir as tabelas e dados falsos no banco:
$ php artisan migrate --seed
Utilize o seguinte comando para iniciar o servidor:
$ php artisan serve
Todos os endpoints da API são prefixados com /apí
e suas documentações estão disponíveis em http://localhost:8000/swagger/