Danils0n23/davi-api

APi

DOCUMENTAÇÃO

• Para iniciar
• Plataforma para execução do projeto
• Servidores/Portas
• Design de software
• Framework
• Base de dados para execução das notificações
• Pré-requisitos
• Comandos básicos
• Banco de dados
• Execução das queue
• Teste-Unintário
• Sobre os testes
• Chamadas da API
• Link da collections
• Erros

Para iniciar o serviço

Essas instruções farão com que você tenha uma cópia do projeto em execução na sua máquina local para fins de desenvolvimento e teste. Veja a implantação de notas sobre como implantar o projeto em um sistema ativo.

Plataforma para execução do projeto

Docker

Para mais informações clique aqui para visitar a documentação oficial do docker Escrevi esse artigo de como Como criar containers com Laravel, PostgreSQL, PgAdmin e NGINX utilizando Docker CLI Para mais informações clique aqui

Servidores e Portas

Serviço	Porta
nginx	80
pgsql	5432
redis	6379
pgadmin	5050
php-fpm	5050

Design de software

S O L I D 

Arquitetura Hexagonal

Framework

Laravel

Base de dados para execução das notificações

Redis

Pré-requisitos

Criar um diretório na are trabalho chamado Hope
Clonar o projecto dentro desse diretório

Executar o docker compuser

docker-compose up 

Comandos básicos

#para entrar no container
docker exec -it php-fpm sh

#para entrar no diretório do projecto
cd <Diretório do projecto>

#para copiar as variáveis de ambiente 
cp .env.docker.example .env

#para instalar as dependência do projecto
composer install

Banco de dados

Configura o seu banco de dados

Acesse o container pgadmin via browser

localhost:5050

EMAIL=user@domain.com
PASSWORD=SuperSecret    

Criar novo server no pgadmin

DB_CONNECTION=pgsql
DB_HOST=postgresql
DB_PORT=5432
DB_DATABASE=dev
DB_USERNAME=postgres
DB_PASSWORD=root

Acessar o container onde esta à aplicacão e dentro do diretório do projecto executar os seguinte comando

php artisan config:clear

composer dump-autoload

php artisan migrate

Teste Unintário

Acessar o container onde esta à aplicacão e dentro do diretório do projecto execute o seguinte comando para executar os testes

vendor/bin/phpunit
ou
php artisan test

Sobre os testes

Recomendamos o uso de qualquer ferramenta client-rest para testes nas chamadas da API.

• INSOMNIA https://insomnia.rest/download/

• POSTMAN https://www.getpostman.com/downloads/

Chamadas da API

Link da collections

Collections: https://api.postman.com/collections/5776403-9b73d5ac-5422-4e77-9ad2-7bb8dcb41809?access_key=PMAT-01HV1JFMZD00Z87X7B1H9DZMJ2

Erros

Se você detectar algum problema que não consiga solucionar, por favor nos informe e se possivel abra uma issue sobre..