openeuropa / oe_webtools
OpenEuropa Webtools integration.
Installs: 38 754
Dependents: 5
Suggesters: 0
Security: 0
Stars: 0
Watchers: 16
Forks: 9
Open Issues: 24
Type:drupal-module
Requires
- php: >=7.2
- ext-json: *
- drupal/core: ^8.8
Requires (Dev)
- composer/installers: ~1.5
- consolidation/annotated-command: ^2.8.2
- consolidation/robo: ~1.4
- drupal/config_devel: ~1.2
- drupal/core-composer-scaffold: ^8.8
- drupal/drupal-extension: ^4.0
- drupal/geocoder: ^3.0
- drupal/geofield: ^1.0
- drupal/json_field: ^1.0@RC
- drupaltest/behat-traits: ~0.1
- drush/drush: ~9.0
- guzzlehttp/guzzle: ~6.3
- nikic/php-parser: ^3.1.5
- openeuropa/behat-transformation-context: ~0.1
- openeuropa/code-review: ~1.5.0
- openeuropa/drupal-core-require-dev: ^8.7
- openeuropa/oe_media: ^1.0@beta
- openeuropa/oe_multilingual: ~1.2
- openeuropa/task-runner: ~1.0.0-beta5
- openeuropa/webtools-geocoding-provider: ~0.1
- phpunit/phpunit: ~6.0
- symfony/dom-crawler: ~3.4
Conflicts
- dev-master
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.0
- 1.0.0
- 0.5.0
- 0.4.1
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
- dev-ISAICP-6273
- dev-EWPP-721
- dev-Release-1.10.0
- dev-OPENEUROPA-2309
- dev-undefined-json-markup-class
- dev-ISAICP-5648
- dev-OPENEUROPA-2533
- dev-clarify-analytics-instance
- dev-marker_point
- dev-check-webtools-maps-contexts-identical
- dev-OPENEUROPA-2258-test-php72
- dev-library_header
- dev-improve-readme
- dev-clean-up-media
- dev-reusable-cck-context
- dev-ISAICP-5502
- dev-update-info-file
- dev-OPENEUROPA-1864-fix-dependencies
- dev-OPENEUROPA-1864_Release1-1-0-0
- dev-OPENEUROPA-1465
- dev-OPENEUROPA-1247
- dev-demo-OPENEUROPA-1108
This package is auto-updated.
Last update: 2021-02-25 10:59:15 UTC
README
Webtools integration for OpenEuropa. Webtools are interactive services available to integrate in a website.
Table of contents:
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
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 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
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
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
-
Customize build settings by copying
runner.yml.dist
torunner.yml
and changing relevant values, like your database credentials. -
Generate configuration files:
./vendor/bin/run drupal:site-setup
- 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
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.