O projeto foi construído utilizando o framework Django Rest Framework. Ele está dividido em 2 serviços: A API, que é responsável por salvar e listar as localizaçãoes, bem como listar localizações próximas com base em uma coordenada e uma distância máxima; O Authenticator que é responsável por registrar e gerenciar os usuários logados no sistema. Os serviços se comunicam por meio de API Rest. O banco de dados utilizado para persistir as infomações foi o PostgreSQL.
Basicamente a API receberá os dados das localizações a serem salvas e inicialmente irá checar no serviço de autenticação se o usuário que está tentando realizar a operação existe, se sim, salvará os dados, caso contrario retornará erro. A mesma coisa ocorre nas rotas de listagem de acordo com a especificação do projeto.
Antes de executar o projeto é preciso certificar-se de ter algumas depências instaladas. Elas são: Python3 (e o pip caso não esteja instalado), o Docker e o Docker Compose.
Depois de instaladas as dependências é possível iniciar o projeto. Para isso execute o seguinte comando:
make runApós isso, basta aguardar até que todos os serviços sejam iniciados e acessar a seguinte url: http://localhost:8081.
Após certificar-se de ter todas dependências instaladas e o projeto iniciado, é preciso popular o banco de dados com as tabelas que serão utilizadas. Para isso, basta executar na raíz do projeto o comando:
make migrateOBS: Só é necessário executar esse comando na primeira vez que em for executar o projeto.
Para executar os testes unitários é necessário ter as dependências instaladas e o bando de dados construído (já explicado em etapas anteriores). Após isso, basta executar o comando:
make testPara acessar a documetação da api, é preciso executar o projeto e acessar a seguinte url: http://localhost:8081/api/docs/schema/swagger-ui/ e para acessar a documentação do serviço de autenticação acesse a seguinte url: http://localhost:8081/auth/docs/schema/swagger-ui/
Inicialmente deve-se criar um novo usuário no serviço de autencitação na rota /auth/register. Após isso é preciso gerar o token de autenticação na rota /auth/api-token-auth/.
Depois de criado o usuário e gerado token, é possível usar as rotas de registro e listagem de localização (/api/location/) e a rota de listagem de localizações próximas (/location/neighbors/)
OBS: Todas estas rotas podem ser testadas diretamente nas documentações da API.
make migrate: Inicia o banco de dados PostgreSQL e cria as tabelas necessárias.
make run: Inicia todos os serviços do projeto.
make test: Executa os testes unitários.
make run-dependecies: Inicia as dependências do projeto
make logs: Visualiza os logs dos serviços
make down: Encerra a execução dos serviços.
make down-dependecies: Encerra a execução das dependências.