lemberg/draft-environment

Development environment for Draft Drupal.

3.6.4 2022-09-23 19:07 UTC

Requires

• php: >=7.4
• composer-plugin-api: ^2.0
• nette/finder: ^2.5.2
• nette/robot-loader: ^3.4.1
• symfony/filesystem: ^3.4.47 || ^4.4.27 || ^5.3.4 || ^6.0.9
• symfony/yaml: ^3.4.41 || ^4.4.9 || ^5.3 || ^6.0.10
• t2l/comments: ^1.1.0

Requires (Dev)

• composer/composer: ^2.2.12 || ^2.3.5
• dealerdirect/phpcodesniffer-composer-installer: ^0.7.1
• dg/bypass-finals: ^1.3.1
• drupal/coder: ^8.3.13
• ergebnis/composer-normalize: ^2.15.0
• ergebnis/phpstan-rules: ^1.0.0
• mikey179/vfsstream: ^1.6.10
• php-mock/php-mock-phpunit: ^2.5
• php-parallel-lint/php-parallel-lint: ^1.3.1
• phpro/grumphp: ^1.5.0
• phpstan/extension-installer: ^1.1.0
• phpstan/phpstan: ^1.8.0
• phpstan/phpstan-deprecation-rules: ^1.0.0
• phpstan/phpstan-phpunit: ^1.1.1
• phpstan/phpstan-strict-rules: ^1.4.0
• phpunit/phpunit: ^9.5.10
• symfony/process: ^3.4.47 || ^4.4.30 || ^5.3.7 || ^6.0.8
• thecodingmachine/phpstan-strict-rules: ^1.0.0

GPL-2.0-or-later

README

This is Vagrant-based development environment for Drupal projects. This project is a part of a Draft Drupal project template.

Prerequisites

• PHP (7.4+) and Composer 2
• Vagrant (2.2.6+)
• VirtualBox (5.2+)
• mkcert (optional)

Vagrant plugins (will be automatically installed)

Vagrant Host Manager

Manages host and/or guest hosts files. Draft is configured to create a hostname.test DNS record on a host machine.

vagrant-disksize

A Vagrant plugin to resize disks in VirtualBox.

Vagrant WinNFSd (WINDOWS only)

Dramatically increases disk IO on Windows by adding NFS support.

How to

1. (Optional) Locally-trusted SSL certificates

   Skip this step if mkcert is already installed and the local CA does already exist.

   Install mkcert in order to get locally-trusted development SSL certificates. This tool requires no configuration. After installation just run:

   $ mkcert -install
   

2. Add Draft Environment to the project (as a dev dependency):

   $ composer require --dev lemberg/draft-environment
   

3. Configure guest machine by answering installer's questions. At the moment, project name (hostname) and PHP version are the only settings that can be set interactively

4. Override any variable used in any Ansible role by manually editing the vm-settings.yml. All available variables alongside with their default values are listed in default.vm-settings.yml

   Here's the list of used roles:

   • draft (internal)
   • oefenweb.swapfile @ v2.0.35
   • geerlingguy.mailhog @ 2.3.0
   • git_config (internal)
   • apache2 (internal)
   • geerlingguy.mysql @ 3.5.0
   • t2l.php @ 1.6.2
   • t2l.composer @ 2.0.5
   • t2l.java @ 1.3.3
   • t2l.solr @ 2.2.2

5. Create and provision the guest machine:

   $ vagrant up
   

6. Commit .gitignore, Vagrantfile and vm-settings.yml to lock the VM state

7. Configuration can be overridden locally by creating and editing vm-settings.local.yml (and this file must not be committed)

Documentation

Everybody loves documentation. We do too! Check this out.

Changelog

Changelog can be found here CHANGELOG.md