robertoperuzzo/drupal-starter

Project template for Drupal 9 projects with a relocated document root

3.0.2 2021-10-29 16:57 UTC

README

Ex. The project contains the company's website.

Repository LAMP Software

Using as a reference

You can use this repository as a reference for your own Drupal projects, and borrow whatever you need.

Create new project

composer create-project robertoperuzzo/drupal-starter:dev-gitpod-drupal-10.x my-project-folder

How does this starter kit differ from vanilla Drupal in Drupal.org?

We added DDEV configuration in .ddev folder.

Starting your local environment

First of all you need Docker and DDEV.

1. Clone the project

Clone this repository wherever you want

git clone git@....  [project-folder-name]
cd [project-folder-name]

2. Build

Start local environment and install drupal from scratch using the current configurations

ddev build

Environment management commands

Here some useful commands to manage your local environment.

Local deployment

When you download new code (git pull from repository) you need to run the following commands in order to sync your local environment:

ddev composer install --prefer-dist
ddev robo scaffold
ddev robo deploy

Export/import configuration

When you change some configuration you have to run:

ddev robo config:export

If you need to sync your local configuration you have to run:

ddev robo config:import

Export/import database

If you need to export the database dump you have to run:

ddev robo database:export

If you need to import the database dump you have to run:

ddev robo database:import [/path/of/dump.sql]

Contrib Modules

This starter kit contains the following contrib modules dependencies:

Module name Package
Admin Toolbar drupal/admin_toolbar
Chaos tool suite (ctools) drupal/ctools
Config Filter drupal/config_filter
Config Ignore drupal/config_ignore
Configuration Split drupal/config_split
Mail System drupal/mailsystem
Metatag drupal/metatag
Monolog drupal/monolog
Pathauto drupal/pathauto
Redirect drupal/redirect
Reroute Email drupal/reroute_email
Simple XML sitemap drupal/simple_sitemap
Sitemap drupal/sitemap
Stage file proxy drupal/stage_file_proxy
Token drupal/token
Twig Tweak drupal/twig_tweak
Permissions filter drupal/permissions_filter