UserAddressApi 👤

Simples RestAPI JWT para registro e autenticação de usuários onde cada usuário pode cadastrar vários endereços.

Desenvolvida com Laravel 11 usando Laravel Sanctum e Docker

🧿 Instalação

Requisitos

• Docker
• Docker Compose

Passos de Instalação

1. Clone o repositório para a sua máquina local:

   git clone https://github.com/netosep/user-address-api.git && cd user-address-api

2. Copie o arquivo de ambiente e construa o container da aplicação utilizando o Docker:

   cp .env.example .env && docker-compose up --build -d

3. Instale as dependencias, suba as migrations e gere a key da aplicação executando o comando:

   docker-compose exec php-fpm composer install-app

Note

Para posteriormente remover totalmente o container criado, redes, volumes e imagens, execute docker-compose down --rmi all dentro da pasta do projeto

💫 Acesso

Após de executar os passos de instalação, a aplicação estará acessível em: http://localhost:8080

📖 Documentação da API

Toda a documentação via Swagger está disponivel no endpoint /api/documentation

🎯 Testes

Para rodar os testes, use o comando abaixo:

docker-compose exec php-fpm php artisan test

📁 Estrutura do Projeto

• app/ - Contém os arquivos principais da aplicação.
• database/ - Contém as migrações e seeders do banco de dados.
• routes/ - Contém as definições de rotas da aplicação.
• tests/ - Contém os testes automatizados.

Developed with 🖤 by Neto Sepulveda