morpht/convivial-recommended

Project template for Drupal 10 projects with a relocated document root

dev-main 2024-02-27 16:51 UTC

This package is auto-updated.

Last update: 2024-04-27 17:09:33 UTC


README

Continous Integration

This is a project template providing a great out-of-the-box experience for new Drupal 10 projects that encapsulates our starting site configuration and basic scaffolding like settings.php. It is based on the Drupal Recommended Project, with the principal difference being the addition of several modules and packages that provide the best possible out-of-the-box personalization experience.

This project includes the following packages and configuration:

Installation and usage

Create a new project using Composer:

composer create-project --no-interaction --stability dev morpht/convivial-recommended myproject

Once you create the project, you can and should customize composer.json and the rest of the project to suit your needs. You will receive updates from any dependent packages, but not from the project template itself. It's yours to keep!

  • Initialize the git in the newproject folder
  • You should only commit changes to composer.json and composer.lock. Do not commit files in the vendor, web/core, and similar directories (these are ignored by the provided .gitignore file).

Local development

  • Initialize the project using lando init and customize your .lando.yml file.
  • Install site locally with Convivial installation profile.

Installation on Pantheon

  • Create Drupal 10 site from link here https://docs.pantheon.io/drupal-10.
  • Edit drush/sites/pantheon/{project}.site.yml to add there Pantheon site hash instead of %hash%
  • Edit repository secrets at github to add there Pantheon git url.
  • Upload database from local to pantheon.
  • Force push your repository to pantheon git.
  • After first push, dev site at Pantheon should be functional.

References