jorgelustosa / location

Api to geocoding and geolocation services

Location API

Info

Sometimes your transactional logistics or geo applications need to consume coordinates, geocodes, addresses, countries or all other kinds of geo information to use in workloads or business intelligence panels without dependence on an external API, also with flexible methods to retrieve a full dataset of information or internal codifications from your own domain.

Furthermore, many high availability projects need to have important services or APIs inside your own infrastructure to minimize the risk of unavailable services.

The main purpose of this project is to create a reliable and flexible API to provide localization information to use in future geocoding capabilities of any software. Some operations from this API can be attached directly to DataAnalytics tools like Microsoft PowerBI and Tableau or Google DataStudio.

Instructions

First of all, you have to put your docker container to work properly. Run the following instructions as described:

Start and Build an image of the container:

# cd docker 
# docker-compose up --build

With you container working properly, run the follow commands inside the locationphp container.

# php artisan migrate:install 
# php artisan migrate
# php artisan db:seed

Operations

• postcode
• countries
• citiesPerCountry
• coordinatesPostcodeList

Documentation

To access the documentation page, when your container is working, just follow the link http://localhost:8080/api/documentation

⚠️ Tips

• When you start your container for the first time, you have to wait a composer to finish the package installation, before using and run commands in your container. When the initialization is complete you will see the follow message in supervisor logs or docker-composer verbose return:
  
  NOTICE: fpm is running, pid 1
  NOTICE: ready to handle connections
  
  After that, you can easily run the commands to seed the database or use the application

Usefull Commands

Stop Docker

# docker-compose stop

Shell access for you docker container:

# docker-compose exec locationphp sh