Digital Maps é um projeto que tem como objetivo criar um sistema de cadastro de usuários e locais, onde o usuário pode cadastrar locais e visualizar locais cadastrados por outros usuários. Foi escolhido a utilização da linguagem PHP com o framework Laravel, por ser um framework robusto e com uma comunidade ativa, além de ser um framework que possui uma curva de aprendizado baixa. A arquitetura do projeto foi pensada para ser escalável e de fácil manutenção, utilizando os princípios do SOLID e DDD.
Para fazer o deploy desse projeto é necessário ter o Docker e o docker-compose rodando na máquina e seguir os passos abaixo.
Clone o projeto
git clone git@github.com:levicosta201/digital-maps.gitEntre no diretório do projeto
cd digital-mapsRode o comando para realizar o build
make buildE após isso, rode o comando para criar as tabelas
make migrateAs vezes pode ser necessário rodar os comandos abaixo, para dar permissão de escrita nas pastas
sudo chmod 777 -R storage sudo chmod 777 -R bootstrap/cacheCaso o arquivo .env não tenha sido criado, crie um arquivo .env e copie o conteúdo do arquivo .env.example para ele
cp .env.example .envPara rodar os testes, rode o seguinte comando
make testCaso deseje gerar automaticamente dados para os testes, rode o comando abaixo
make seedPara acessar o coverage e visualizar a coberturas do testes unitários, basta acessar reports/index.html
Para localizar a documentação da api, você pode, após subir o projeto, acessar a url /swagger e encontratrá todos os endpoints livres para realizar requisições.