README

Webtools integration for OpenEuropa. Webtools are interactive services available to integrate in a website.

Table of contents:

Installation
Development setup
Contributing
Versioning

Installation

The recommended way of installing the OpenEuropa Webtools module is via Composer.

composer require openeuropa/oe_webtools

Enable the module

In order to enable the module in your project run:

./vendor/bin/drush en oe_webtools

Webtools configuration

To override the default js file URL for smartloader, you can add the:

$settings['webtools_smart_loader_js_url'] = 'https://webtools.europa.eu/load.js';

If you wish to use the default, you don't need to do anything, it works out of the box.

OpenEuropa Webtools Analytics

The Webtools module contains a submodule that provides a service for providing analytics information. For more information on how to use and configure this module, check out the module README.

OpenEuropa Webtools Captcha

The Webtools module contains a submodule that integrates the webtools captcha capabilities. For more information on how to use and configure this module, check out the module README.

OpenEuropa Webtools eTrans

The Webtools eTrans module provides a block that will show a link to the machine translation service of the European Commission. Visitors can click this link to have the current page translated in their preferred language.

OpenEuropa Webtools Laco Service

The Webtools module contains a submodule that provides a service for retrieving information about language coverage of entity resources. For more information on how to use and test this module, check out the module README.

OpenEuropa Webtools Laco Widget

The Webtools module contains a submodule that provides a widget which integrates with the Laco service. For more information on how to use and configure this module, check out the module README.

OpenEuropa Webtools Geocoding

The Webtools module contains a submodule that provides a widget which integrates with the Geocoding service.

Requirements for Webtools Geocoding

Webtools Geocoding Usage

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

drush en oe_webtools_geocoding

OpenEuropa Webtools Maps

The Webtools module contains a submodule that provides a widget which integrates with the maps service.

Requirements for Webtools Maps

drupal/geofield 1.x

OpenEuropa Webtools Cookie Consent

The Webtools module contains a submodule that provides a service for providing Cookie Consent Kit. For more information on how to use and configure this module, check out the module README.

OpenEuropa Webtools Media

The Webtools module contains a submodule that provides webtools widgets as supported media providers.

Requirements for Webtools Media

drupal/json_field 1.x-rc3

OpenEuropa Webtools Social Share

The Webtools module contains a submodule that provides social sharing functionality for a site.

Development setup

You can build the test site by running the following steps.

Install all the composer dependencies:

composer install

This will build a fully functional Drupal test site in the ./build directory that can be used to develop and showcase the module's functionality.

Before setting up and installing the site make sure to customize default configuration values by copying runner.yml.dist to ./runner.yml and overriding relevant properties.

This will also:

Symlink the theme in ./build/modules/custom/oe_webtools so that it's available for the test site
Setup Drush and Drupal's settings using values from ./runner.yml.dist. This includes adding parameters for EULogin
Setup PHPUnit and Behat configuration files using values from ./runner.yml.dist

Please note: project files and directories are symlinked within the test site by using the OpenEuropa Task Runner's Drupal project symlink command.

If you add a new file or directory in the root of the project, you need to re-run drupal:site-setup in order to make sure they are be correctly symlinked.

If you don't want to re-run a full site setup for that, you can simply run:

$ ./vendor/bin/run drupal:symlink-project

Install the site:

./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 the tests

To run the grumphp checks:

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

To run the phpunit tests:

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

To run the behat tests:

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

Step debugging

To enable step debugging from the command line, pass the XDEBUG_SESSION environment variable with any value to the container:

docker-compose exec -e XDEBUG_SESSION=1 web <your command>

Please note that, starting from XDebug 3, a connection error message will be outputted in the console if the variable is set but your client is not listening for debugging connections. The error message will cause false negatives for PHPUnit tests.

To initiate step debugging from the browser, set the correct cookie using a browser extension or a bookmarklet like the ones generated at https://www.jetbrains.com/phpstorm/marklets/.

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.

openeuropa / oe_webtools

Maintainers

Details