OpenEuropa Bootstrap base theme

Drupal 8/9 theme based on Bootstrap 5 and UI Patterns.

Paragraphs

The paragraphs below are not yet themed therefore not recommended for usage:

Contextual navigation
Document
Fact
Facts and figures
Listing item
Listing item block
Rich text

Requirements

This depends on the following software:

PHP 7.3

Installation

The recommended way of installing the OpenEuropa Bootstrap Theme is via Composer.

composer config repositories.oe_bootstrap_theme vcs https://github.com/openeuropa/oe_bootstrap_theme
composer require openeuropa/oe_bootstrap_theme

Enable the theme

In order to enable the theme in your project perform the following steps:

Enable the OpenEuropa Bootstrap Theme Helper module ./vendor/bin/drush en oe_bootstrap_theme_helper
Enable the OpenEuropa Bootstrap Theme and set it as default ./vendor/bin/drush config-set system.theme default oe_bootstrap_theme

Integration with oe_paragraphs

In order to have full working integration with paragraphs in your project, you must enable oe_boostrap_theme_paragraphs module:

./vendor/bin/drush en oe_bootstrap_theme_paragraphs

Development setup

You can build the development site by running the following steps:

To install required Node.js dependencies run:

npm install

To build the final artifacts run:

npm run build

This will compile all SASS and JavaScript files into self-contained assets that are exposed as [Drupal libraries][11].

In order to download all required PHP code run:

composer install

A post command hook (drupal:site-setup) is triggered automatically after composer install. It will make sure that the necessary symlinks are properly setup in the development site.

Install test site by running:

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

Your test site will be available at ./build.

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

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 -u node node npm install
docker-compose exec -u node node npm run build
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

sub-theme

All the necessary files for sub-theme creation can be found in the kits folder, read the related documentation

Important: The components module needs to be enabled to allow the use of the BCL library with the @oe_bcl namespace.

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.

dxvargas / oe_bootstrap_theme