digitalpolygon/drupal-recommended-project

Project template for Drupal 9 projects with a relocated document root

0.0.1 2022-05-27 06:20 UTC

Requires

• composer/installers: ^1.9
• cweagans/composer-patches: ^1.7
• drupal/admin_toolbar: ^3.1
• drupal/advagg: ^4.1
• drupal/config_ignore: ^2.3
• drupal/core-composer-scaffold: ^9.3
• drupal/core-project-message: ^9.3
• drupal/core-recommended: ^9.3
• drupal/focal_point: ^1.5
• drupal/gin: ^3.0@beta
• drupal/metatag: ^1.19
• drupal/paragraphs: ^1.14
• drupal/pathauto: ^1.10
• drupal/recaptcha: ^3.0
• drupal/redirect: ^1.7
• drupal/seckit: ^2.0
• drupal/webform: ^6.1
• drush/drush: ^11.0

Requires (Dev)

• drupal/core-dev: ^9.3
• drupal/devel: ^4.1
• friendsoftwig/twigcs: ^6.0
• mglaman/drupal-check: ^1.4
• vijaycs85/drupal-quality-checker: ^1.5

Conflicts

• drupal/drupal: *

GPL-2.0-or-later

README

This is an opinionated project template for new Drupal 9 projects. It is based on the Drupal Recommended Project, with the principal difference being the addition of several modules and themes.

It includes

• Drupal Core
• Drush (Drupal CLI and development tool)
• DDev
• Asset Packagist repository, package, and configuration
• GrumPHP

Installation and usage

Create a new project using composer

composer create-project --no-interaction digitalpolygon/drupal-recommended-project

After creating the project, it can be completely customized to suite your requirements. You should never update the project template.

Local Setup

Once you have the project dependencies setup on your local environment, you should be able to setup your local environment with the sites.

1. Create a composer project using

composer create-project --no-interaction digitalpolygon/drupal-recommended-project

1. Configure git by executing
   • git config user.email "[e-mail]"
   • git config user.name "Your Name"
2. Move into the project folder - cd drupal-recommended-project
3. If you are using Macbook M1 please proceed to Configuring Project for Apple M
4. Run ddev setup to build your project locally
5. Your local site should be up and running

Configuring Project for Apple M1

1. Update .ddev/docker-compose.local.yaml

Create the file if it doesn't already exist. Update it so that the web service has property platform: linux/x86_64. Example: adfdsaf

services:
  web:
    platform: linux/x86_64

2. Update .ddev/config.local.yaml

Create the file if it doesn't already exist. Update it so mutagen_enabled: true is set.

Useful ddev commands

1. ddev setup - Use this command to setup the project from scratch.
2. ddev refresh - Use this command to sync your local with dev environment.
3. ddev xdebug on - Use this command to enable xdebug.
4. ddev frontend - Builds frontend dependencies.

Frontend Theme

Please add your FE build commands in build.sh script available in scripts directory.

Pantheon Integration

• To integrate with pantheon please include digitalpolygon/drupal-pantheon-integration composer package.

composer require digitalpolygon/drupal-pantheon-integration

• Update provider.yml to use pantheon as a provider
• Update refresh command to use pantheon as provider