openeuropa / oe_content_extra
OpenEuropa Drupal module that adds additional fields and structure to content types from oe_content.
Installs: 3 203
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 13
Forks: 0
Open Issues: 0
Type:drupal-module
Requires
- php: >=8.1
- drupal/core: ^10
Requires (Dev)
- composer/installers: ^2.0
- drupal/address: ^1.10
- drupal/composite_reference: ^2.1
- drupal/config_devel: ^1.9
- drupal/core-composer-scaffold: ^10
- drupal/core-dev: ^10
- drupal/description_list_field: ^1.0.0-alpha5
- drupal/entity_reference_revisions: ^1.9
- drupal/field_group: ^3.2
- drupal/typed_link: ^2.0.1
- drush/drush: ^12.4
- openeuropa/code-review: ^2.0.0-alpha6
- openeuropa/oe_content: ^3
- openeuropa/task-runner-drupal-project-symlink: ^1.0.0-beta6
- phpspec/prophecy-phpunit: ^2
This package is auto-updated.
Last update: 2024-11-03 16:50:28 UTC
README
Enhances the basic OpenEuropa Content module with additional fields and entity types.
It is primarily designed to be used with the OpenEuropa Whitelabel theme.
Development setup
Using LAMP stack or similar
This is not officially supported. You are on your own.
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
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.