Esse repositório não será mais utilizado, pois como estamos utilizando microserviços, foi decidido que esse repositório foi transferido para Gaia-Esporte
Esse serviço é responsável por pegar a longitude e a latitude a partir do nome de um local através da API Open Cage Data.
Se tiver interesse em como contribuir para o projeto, olhe nossa wiki.
Antes de rodar o projeto é preciso criar um arquivo chamado .env na pasta raiz com o seguinte conteúdo:
API_KEY={Sua chave da API OpenCageData}
Para conseguir uma chave de API entre no site da Open Cage Data
O nosso projeto utiliza o Docker e o Docker Compose como ferramentas de desenvolvimento. Para instalar eles, siga o tutorial no site oficial do Docker.
Após instalar o docker rode o projeto como desenvolvimento da seguinte maneira:
$ sudo docker-compose up --build
Para rodar os testes, utilize:
$ sudo docker-compose run gaialocal npm run test
Para rodar a folha de estilo, utilize este comando:
$ sudo docker-compose run gaialocal npm run lint
Aqui se encontra todos os endpoints desse serviço. Todos os endpoints se encontra em localhost:3001.
| Requisição | Endpoint | Parâmetro:Tipo | Descrição |
|---|---|---|---|
| GET | / | - | Retorna todas as endpoints do microserviço. |
| GET | /local | address: String | Recebe o nome de um local e retorna as coordenadas do local informado. |
| GET | /listLocales | address: String | Recebe o nome de um local e retorna uma lista com os possíveis locais informado. |