README

This is based on drupal-composer/drupal-project.

This project template provides a starter kit for creating a website using Drupal 8.

Starting a new project is a 4 step procedure:

0. Prerequisites

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

1. Create the project

The project can be created using the following command:

$ composer create-project pfrenssen/drupal-site-template --stability=dev my-drupal-project

This will download the starterkit into the my-drupal-project 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.

2. Configuration

First let's move into the project's folder:

$ cd my-drupal-project

The project ships with default configuration that is intended to run the website on the Docker containers we provide. If you are content with using these, you can skip directly to step 3.

If you want to run the website using your locally installed LAMP stack, you will want to change the configuration to match your local system.

Customize the default configuration values by copying runner.yml.dist to 'runner.yml`:

$ cp runner.yml.dist runner.yml

Now edit runner.yml with your most beloved text editor. You will want to set the database host to localhost, and provide the correct database name and credentials. Also update the base_url and Selenium path to match your local environment.

3. Installation

3.1. Using Docker

Copy docker-compose.yml.dist into docker-compose.yml.

You can make any alterations you need for your local Docker setup. However, the defaults should work out of the box.

Download and start the supplied Docker images:

$ docker-compose up -d

Next, install the website:

$ docker-compose exec web ./vendor/bin/run drupal:site-install

Once this completes your website will be available on http://localhost:8080/web/

To verify whether everything works as expected, you can run the example Behat test suite:

$ docker-compose exec web ./vendor/bin/behat

3.2. Using a local LAMP stack

Install the website using the task runner:

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

The site will be available through your local web server.

To verify whether everything works as expected, you can run the example Behat test suite:

$ ./vendor/bin/behat

4. Commit and push

The final step is to create a new git repository and commit all the files. A .gitignore file is provided to ensure you only commit your own project files.

$ git init
$ git add .
$ git commit -m "Initial commit."

Now you are ready to push your project to your chosen code hosting service.

pfrenssen / drupal-site-template

Maintainers

Details