Download the PHP package woprrr/drupal8-composer-template without Composer

Drupal 8 Composer Skeleton

Drupal 8 skeleton dockerized in sperate containers (Nginx, PHP-FPM, MySQL and PHPMyAdmin).

Overview

1. Install prerequisites

   Before installing project make sure the following prerequisites have been met.

2. Clone the project

   We’ll download the code from its repository on GitHub.

3. Configure Xdebug [Optional]

   We'll configure Xdebug for IDE (PHPStorm or Netbeans).

4. Run the application

   By this point we’ll have all the project pieces in place.

5. Use Makefile [Optional but strongly encouraged for beginner]

   When developing, you can use Makefile for doing recurrent operations.

6. Use Docker Commands

   When running, you can use docker commands for doing recurrent operations.

Install prerequisites

For now, this project has been mainly created for Unix (Linux/MacOS). Perhaps it could work on Windows.

All requisites should be available for your distribution. The most important are :

• Git
• Docker
• Docker Compose

Check if docker-compose is already installed by entering the following command :

Check Docker Compose compatibility :

• Compose file version 3 reference

The following is optional but makes life better :

Images to use

• Nginx
• MySQL
• PHP-FPM
• PHPMyAdmin
• Generate Certificate

You should be careful when installing third party web servers such as MySQL or Nginx.

This project use the following ports :

Clone the project

To install Git, download it and install following the instructions :

Go to the project directory :

Project tree

Configure Xdebug

If you use another IDE than PHPStorm or Netbeans, go to the remote debugging section of Xdebug documentation.

For a better integration of Docker to PHPStorm, use the documentation.

1. Get your own local IP address :

2. Edit php file etc/php/php.ini and comment or uncomment the configuration as needed.

3. Set the remote_host parameter with your IP :

Run the application

1. Setup project environment variables :

   Setup your project by editing the .env file and customize all environement variables. Specifically all Drupal_* variable are criticaly important to next steps and to customize your drupal instances.

2. Initialize/Install project dependencies :

   Please wait this might take a several minutes...

3. Install Drupal instance :

   Or specify name of configuration instance

   All of configuration available are defined in your settings/settings.local.php file from

   Example of typical workflow with configuration

4. Open your favorite browser :

   • http://localhost:8000 (Web Front).
   • https://localhost:3000 (Web Front HTTPS).
   • http://localhost:8080 PHPMyAdmin (username: dev, password: dev)

5. Stop and clear services :

6. Stop and delete all traces of changes from skeleton :

   That delete all files to reset skeleton at his initial state.

Play with Drupal Configuration workflow

1. Export your current configuration instance

   Or with Docker Compose

2. After your first install of Drupal instance edit the .env file and change the following variable DRUPAL_INSTALL_PROFILE=standard to DRUPAL_INSTALL_PROFILE=config_installer. That take ability to re-install / update your drupal instance with ./config/* exported configuration states.

3. Re-install or update your instance from exported configuration

   Re-install: With Drop of current drupal database and complete re-import of ./config

   Update: With following drupal commands (up-db / ent-up ).

   Every action processed by scripts switch your Drupal instance on maintenance mode and switch Online after every action automatically.

4. In more advanced usage you can also specified a drupal configuration name

   Or with Docker Compose

Examples of life cycle

1. Start the Project containers :

2. Edit .env file.

3. Install drupal 8 instance :

4. Exporting Drupal configuration files :

   **Or with a specific destination**

5. Enable Re-install from configuration mode : Edit .env file by changing DRUPAL_INSTALL_PROFILE=standard to DRUPAL_INSTALL_PROFILE=config_installer.

6. Re-installation of project from exported configuration :

7. Update of current instance : Edit one of configuration yml in your /config folder eg: system.site.site_name. and process to updating your drupal instance from configuration by using

   Your Site Name will change that you specified in system.site.site_name yml file.

8. Another tips ? Call Help ;) : Show help :

Use Makefile

When developing, you can use Makefile for doing the following operations :

Use Docker commands

Installing package with composer

Requiring package with composer

Updating PHP dependencies with composer

Testing PHP application with PHPUnit

Fixing standard code with CODER

Checking the standard code with CODER

Checking installed PHP extensions

Handling database

MySQL shell access

and

Creating a backup of all databases

Restoring a backup of all databases

Creating a backup of single database

Notice: Replace "YOUR_DB_NAME" by your custom name.

Restoring a backup of single database

Connecting MySQL from PDO

Or using Drush to check if your database configuration is OK

Help us

Any thought, feedback or (hopefully not!)