Drupal Skeleton

This is a template for starting Drupal 8 projects using the composer create-project command.

Quick start

This "quick start" section will show you how to set up a local server accessible at http://example.local with Drupal ready to install.

Preface

You should have the development dependencies installed on your Mac before you begin. These dependencies are not project-specific, and you may have some or all of them already installed. If you don't, find a location with good internet and set aside at least an hour to complete this step.

The development dependencies are:

PHP 7
- Check your PHP version from the command line using php --version
XCode
Composer
Ansible
- We recommend installing with homebrew: brew install ansible
Vagrant
VirtualBox
Vagrant plugins: hostmanager and auto_network
- Install both with this command: vagrant plugin install vagrant-hostmanager vagrant-auto_network

Once you have your dependencies installed, setting up this skeleton will take at least another hour, depending on your internet connection.

Some of the commands below will prompt you for a response, with the default answer in brackets. For this quick start, hit return to accept each default answer:

Enter a short name for your project [example] :

Steps

Create a new project called "example" based on this template:

composer create-project palantirnet/drupal-skeleton example dev-develop --no-interaction

Go into your new project directory and run the script from palantirnet/the-vagrant to set up a Vagrant environment:

cd example
vendor/bin/the-vagrant-installer

From inside the VM, run the script from palantirnet/the-build to set up the default Drupal variables and install Drupal:

vagrant up
vagrant ssh
vendor/bin/the-build-installer

In your web browser, visit http://example.local -- if you type in this URL, you will need to include the http:// portion for your browser find the site.
Optional: While you are logged into the Vagrant environment, you can run Drush commands like drush status.

Extra Credit

Log into the vagrant box (vagrant ssh) and export the Drupal configuration (drush config-export)
Update the README.md based on the contents of README.dist.md
Update the project name in the composer.json file, then run composer update --lock
Initialize a git repository and commit your work
Access your database via phpMyAdmin at http://example.local/phpmyadmin using the username drupal and the password drupal
View email sent by your development site at http://example.local:8025
View your Solr 4.5 server at http://example.local:8983/solr
Note that renaming or moving this example/ directory can break your Vagrant machine

Full Project Setup

Create a project with a custom name

Use composer to create a new project based on this skeleton, replacing PROJECTNAME with the short name for your project:

composer create-project palantirnet/drupal-skeleton PROJECTNAME dev-develop --no-interaction

Update your documentation

Update the README:

Remove the README.md
Rename the README.dist.md to README.md
Edit as you like

Update the LICENSE.txt:

Remove or replace this file with the appropriate license for your project. (The existing license applies to the Drupal Skeleton template only.)

Update the composer.json:

Change the name from palantirnet/drupal-skeleton to palantirnet/PROJECTNAME
Update the description with a brief description of your project.
Update the license property based on how your work will be licensed
Update the lock file so composer doesn't complain:

  composer update --lock

Run the installers

Go into your new project directory and run the script from palantirnet/the-vagrant to set up a Vagrant environment:

cd PROJECTNAME
vendor/bin/the-vagrant-installer

From inside the VM, run the script from palantirnet/the-build to set up the default Drupal variables:

vagrant up
vagrant ssh
vendor/bin/the-build-installer

Commit your work to git

Initialize a git repository and commit your work to the develop branch:

git init
git checkout -b develop
git commit --allow-empty -m "Initial commit."
git add --all
git commit -m "Add the skeleton."

Create an empty repository on GitHub for your work. Then, push your work up to the repository:

git remote add origin git@github.com:palantirnet/PROJECTNAME.git
git push -u origin develop

Manage your Vagrant VM

Start or wake up your Vagrant VM: vagrant up
Log in: vagrant ssh
Log out (just like you would from any other ssh session): exit
Shut down the VM: vagrant halt
Check whether your VM is up or not: vagrant status
More information about this Vagrant setup is available at palantirnet/the-vagrant
See also the official Vagrant documentation

Install Drupal from the command line

When using drush or phing to manage your Drupal site, you will need to log into the vagrant box (vagrant ssh).

You can use the phing scripts provided by palantirnet/the-build:

vendor/bin/phing build install

Or, you can use drush directly:

drush site-install

Manage your configuration in code

Drupal 8 supports exporting all of your configuration. On top of this core process, we use the config_installer profile to allow us to use the exported configuration as the basis for a repeatable, automation-friendly build and install process.

Log into Drupal in your browser and do some basic config customizations:

Set the site timezone
Disable per-user timezones
Disable user account creation
Remove unnecessary content types
Set the admin email address (your VM will trap all emails)
Turn the Cron interval down to "never"
Uninstall unnecessary modules (e.g. Search, History, Comment)

Export your config:

drush cex -y

Update the install profile in your default build properties (conf/build.default.properties):

drupal.install_profile=config_installer

You should have a ton of new *.yml files in conf/drupal/config. Add them, and this config change, to git:

git add conf/
git ci -m "Initial Drupal configuration."
git push

Reinstall your site and verify that your config is ready to go:

vendor/bin/phing build install

More information

Site build and install process: palantirnet/the-build
Development environment setup: palantirnet/the-vagrant

shaal / drupal-skeleton