sgrichards/drupal-startup

Startup template for Drupal 8 projects.

 ____ _____  _    ____ _____ _   _ ____
/ ___|_   _|/ \  |  _ \_   _| | | |  _ \
\___ \ | | / _ \ | |_) || | | | | | |_) |
 ___) || |/ ___ \|  _ < | | | |_| |  __/
|____/ |_/_/   \_\_| \_\|_|  \___/|_|

########################################

, _(*1)

Drupal 8 / Lando flavoured project template

This project should be used as a skeleton starting point for new Drupal 8 based projects. As such some assumptions and opinionated decisions are included to bootstrap a project with everything you might need to get started!, _(*2)

...delete as appropriate!, _(*3)

Start me up

Start-up your newproject in the current directory using composer:, _(*4)

composer create-project --no-install -s dev inviqa/drupal-startup newproject, _(*5)

Update the .gitignore in the project root, _(*6)

Project structure

The tree below outlines the project structure and purpose., _(*7)

newproject
|
├── conf # container related config (eg. solr)
├── config
|   └── sync # Drupal config files
|
├── doc # Project related documentation
|
├── docroot
|   ├── modules
|   |   └── custom # Custom modules
|   ├── profiles
|   |   └── custom # Custom install profiles
|   ├── sites
|   |   └── default # Default site settings
|   └── themes
|       └── custom # Custom themes
|
├── scripts
|   ├── deployment # Shell scripts for deployment
|   ├── development # Shell scripts for local dev
|   └── common.inc.sh # Shared scripts for all environments
|
└── test
    └── behat # Behat tests

Development Environment

Prerequisites

1. Install Docker-for-mac
2. Install Lando.

Note: Compatible with v3.0.0-rc1 and below, _(*8)

Setup

Run lando start from within the project directory., _(*9)

Tooling

For further lando related commands see: https://docs.devwithlando.io/config/tooling.html, _(*10)