This will provide you with a starting Drupal project that is managed with Composer. The install will include a small set of contrib modules, a starting custom module for specific for the build, and a custom starting theme generated from Emulsify.
Use this command below and replace PROJECT_NAME with your chosen project name.
composer create-project fourkitchens/sous-drupal-project PROJECT_NAME --no-interaction
Install your theme
- Follow the theme's setup instructions found in
/web/themes/contrib/emulsify-design-system - Recommended naming for the theme is
/web/themes/custom/PROJECT_NAME
Create a new project module
Generate a custom module at /web/modules/custom/PROJECT_NAME using drupal console.
Follow the documentation for the generate:module command here
Get a local environment oporating. You can use the included lando configuration. Requires Lando
lando start
View your local URL and follow the install.
This package provides some additional tooling to support the build.
To use the helper script provided you will need to have yarn or npm installed. Then just run yarn <command> or npm run <command>. For example: yarn import-data. These commands are bash scripts located in the ./scripts/sous directory and defined in package.json.
confex
yarn confex
Export active configuration to the config directory.
confim
yarn confim
Import the configuration to the database.
import-data
yarn import-data
Import a copy of the canonical database backup into your local instance. This assumes the database backup is located in ./reference/db.sql.gz.
local-data-bak
yarn local-data-bak
Create a local database backup. Saves the backup to the ./reference directory.
rebuild
yarn rebuild
Rebuild a fresh local instance of your site. Imports the canonical database backup and imports configuration into it.