This is based on drupal-composer/drupal-project.
This project template provides a starter kit for creating a website using the OpenEuropa Drupal 8 platform. It will install the OpenEuropa Profile which is a lightweight installation profile that includes the minimal number of modules that are required to enable the OpenEuropa Theme. Using this theme will ensure that the project complies with the guidelines for European Component Library.
In order to build the functionality of the website you are free to use any of the OpenEuropa components.
You need to have the following software installed on your local development environment:
The project is built using Composer create-project.
This is the equivalent of doing a git clone
followed by a composer install
.
One does not need to be in this repository in order to use the composer create-project
command.
The project can be created using the following command:
composer create-project openeuropa/drupal-site-template --stability=dev <dg-name>-<project-id>-reference
For local development, to test the Setup Wizard, run composer setup
from the root of this project.
This will download the starterkit into the <dg-name>-<project-id>-reference
folder and a
wizard will ask you for the project name and your organisation. It will use this
information to personalize your project's configuration files.
The installer will then download all dependencies for the project. This process takes several minutes. At the end you will be asked whether to remove the existing version history. It is recommended to confirm this question so that you can start your project with a clean slate.
After installing the dependencies, install a clean installation of your site, using the following command:
./vendor/bin/run toolkit:install-clean
Using default configuration, the development site files should be available in the build
directory.
Before to commit your project on your repository, export the configuration on config/sync
using the following command:.
./vendor/bin/drush cex
A .drone.yml
file is provided for running CI tests on Drone. Further details of how to set this up can be found in the
drone documentation.
It is recommended that the version of oe_theme
is locked to the current minor version before going live with the
project, so that updates to the theme do not cause problems to a running site. We recommend that this is periodically
updated to the latest version, after doing manual testing.
A separate .gitignore
file is provided which is used for the project. Drupal scaffold files should be committed after
running composer install or update. See the
Drupal scaffold documentation
for further details.
Further details of how to build sites, install Drupal and run tests can be found in the README.md
found within your site
folder.
Now you are ready to push your project to your chosen code hosting service.