openeuropa/oe_webtools_location

Adds support for Webtools location services in Drupal.

Installs: 8 040

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 10

Forks: 1

Open Issues: 1

Type:drupal-module

0.1.3 2019-06-17 09:15 UTC

This package is auto-updated.

Last update: 2020-09-17 11:29:37 UTC


README

This repository has been deprecated in favor of the OpenEuropa Webtools component, all the functionality that was available in this repository will continue to be supported there instead.

OpenEuropa Webtools Location Services

No Maintenance Intended

This is a Drupal module that provides integration with Webtools location services, such as geocoding and maps.

Table of contents:

Supported services

The different Webtools location services are placed in submodules. This allows you do only enable the submodules for the services you actually need. Currently the following services are supported:

Requirements

This depends on the following software:

Requirements for Webtools Geocoding

Installation

  • Install the package and its dependencies:
composer require openeuropa/oe_webtools_location

Usage

Webtools Geocoding

If you want to use the Webtools Geocoding service, enable the submodule:

drush en oe_webtools_geocoding

Development setup

You can build a local development environment by executing the following steps:

Using a local LAMP stack

Step 1: Install dependencies

composer install

Step 2: Configure the environment

Copy runner.yml.dist to runner.yml and change the configuration to match your local environment. Typically you will need to specify localhost as your database host, and change your base URL and database credentials.

Step 3: Install

./vendor/bin/run drupal:site-install

Your test site will be available at ./build.

Using Docker Compose

Alternatively, you can build a development site using Docker and Docker Compose with the provided configuration.

Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration.

Requirements:

Configuration

By default, Docker Compose reads two files, a docker-compose.yml and an optional docker-compose.override.yml file. By convention, the docker-compose.yml contains your base configuration and it's provided by default. The override file, as its name implies, can contain configuration overrides for existing services or entirely new services. If a service is defined in both files, Docker Compose merges the configurations.

Find more information on Docker Compose extension mechanism on the official Docker Compose documentation.

Usage

To start, run:

docker-compose up

It's advised to not daemonize docker-compose so you can turn it off (CTRL+C) quickly when you're done working. However, if you'd like to daemonize it, you have to add the flag -d:

docker-compose up -d

Then:

docker-compose exec web composer install
docker-compose exec web ./vendor/bin/run drupal:site-install

Using default configuration, the development site files should be available in the build directory and the development site should be available at: http://127.0.0.1:8080/build.

Running tests

Using a local LAMP stack

Coding standards

./vendor/bin/grumphp run

Unit tests

./vendor/bin/phpunit

Using Docker Compose

Coding standards

docker-compose exec web ./vendor/bin/grumphp run

Unit tests

docker-compose exec web ./vendor/bin/phpunit

Contributing

Please read the full documentation for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the available versions, see the tags on this repository.