vever001/drupal-site-template

A template for setting up an OpenEuropa Drupal site.

0.1.0 2019-05-07 09:01 UTC

Requires

• php: ^7.1
• composer/installers: ^1.5
• cweagans/composer-patches: ^1.0
• drupal-composer/drupal-scaffold: ^2.5
• drupal/core: ^8.7
• drush/drush: ^9.0
• openeuropa/composer-artifacts: ~0.1
• openeuropa/oe_profile: ^0.2
• openeuropa/oe_theme: ^0.9
• webflo/drupal-finder: ^1.0
• webmozart/path-util: ^2.3

Requires (Dev)

• drupal/console: ~1.6
• drupal/drupal-extension: ~4.0
• ec-europa/toolkit: ~4.0.0-beta2
• webflo/drupal-core-require-dev: ~8.7

Conflicts

• drupal/drupal: *

EUPL-1.2

README

Please note: this repository contains code that is necessary to generate a new Drupal 8 project, please read carefully this README.md. Do not clone this repository.

You need to have the following software installed on your local development environment:

• Git
• Docker
• Docker Compose

How do I get my new OpenEuropa project codebase?

First of all choose carefully the name of your new project, it should respect the following convention:

<dg-name>-<project-id>-reference

After that contact the QA team, they will create for you a new repository at:

https://github.com/ec-europa/<dg-name>-<project-id>-reference

Then generate your new Drupal 8 project codebase by running the following command:

docker run --rm -ti -v $PWD:/var/www/html -w /var/www/html fpfis/httpd-php-dev:7.3 composer create-project vever001/drupal-site-template --stability=dev --remove-vcs <dg-name>-<project-id>-reference

This will download this 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 completing the command above you can push the content of <dg-name>-<project-id>-reference to the GitHub repository created for you by the QA team.

Ok, I've got my codebase, what should I do now?

1. The steps to get your new site up and running can be found in <dg-name>-<project-id>-reference/README.md.
2. Check the OpenEuropa Documentation for a list of available components, best practices, etc.
3. Make sure you master the concepts of Configuration Management and the related development workflow in Drupal 8.

Should I clone this GitHub project?

No, this repository will only generate your new project's codebase, you then need to push the generated codebase to a dedicated repository, as explained above.