João Gabriel dos Santos Rodrigues

getLocalProject

Projeto para coletar dados de localização

Tecnlogias usadas:

• Docker e DockerComposer - Criação do container com a aplicação
• Git e GitHub - Versionamento
• PHP - Linguagem de programação
• Composer - Instalar repositórios externos
• Laravel - Framework
• Model - Eloquent
• Migrations - Criar base de dados ao iniciar a aplicação
• Sqlite - Base de dados
• PHPUnit - Teste automatizados
• Artisan - CLI do Laravel

Passo-a-passo para fazer o projeto funcionar:

1 - Ter instalado o docker e o docker-compose na maquina (no Windows normalmente o docker-compose é instalado junto do docker).

2 - Baixar o projeto do github no seguinte endereço:

https://github.com/psico/getLocalProject

3 - Com o projeto baixado é preciso gerar um token no github (algumas bibliotecas do laravel exigem isso), para gerar essa chave entre no endereço https://github.com/settings/tokens e click em "Generate New Token" (é necessário loggar no github)

4 - Com o token gerado em mãos, abra o arquivo do endereço abaixo com um editor de texto como bloco de notas ou similar:

getLocalProject\Dockerfile

5 - No arquivo aberto, na linha 20 subistitua o COLOQUE_O_TOKEN_AQUI pelo token gerado no github, feito isso pode salvar e fechar o arquivo.

6 - Agora abra o prompt/bash no diretorio do projeto baixado e execute esse comando (esse comando pode demorar um pouco até terminar):

docker-compose up 

7 - E se tudo deu certo basta acessar o endereço e aparecera a documentação do Laravel se estiver tudo certo:

http://localhost:5001/

ROTAS / ENDPOINTS

Trazer todos as localizações inseridas

GET http://localhost:5001/api/localizacao

Busca uma localização pelo id

GET http://localhost:5001/api/localizacao/{id}

Busca uma localização pelo id Usuário

GET http://localhost:5001/api/localizacaoUser/{id}

Inserir uma localização

POST http://localhost:5001/api/localizacao?latitude={numero}&longitude={numero}&user_id={numero}

TESTES AUTOMATIZADOS

Para executar os teste automatizados será necessário entrar no container da aplicação, segue os passo-a-passo:

1 - Com a aplicação ativa, execute esse comando para ver o ID do container: docker ps

2 - O ID do container deve estar na primeira coluna listada e na coluna imagem deve estar escrito getlocalproject_php

3 - Agora execute o esse comando subistituindo o COLOQUE_ID_CONTAINER pelo ID que conseguiu no comando anterior: docker exec -it COLOQUE_ID_CONTAINER bash

4 - Pronto com isso você estará dentro do container.

5 - Verifique se está no diretório:

/var/www/html/getLocalProject#

6 - Agora para executar os testes, escolha um dos dois comandos abaixo:

php vendor/bin/phpunit
    
php artisan test