README

Sous Project

A starter kit for your Drupal project that simplifies your project setup with Emulsify. This starter kit includes a small set of contrib modules, a bundle of basic configuration, and a starter theme generated by EmulsifyCLI.

Features and Configurations

Sous not only generates a custom theme based on Emulsify, it also builds upon Drupal's default configuration to help streamline the project setup process. See the feature set documentation here.

Installation

Dependencies and Requirements

Without these you will have difficulty installing this project.

Use this command below and replace PROJECT_NAME with your chosen project name.

composer create-project fourkitchens/sous-drupal-project [PROJECT-NAME]

Note that by default, the project will use DDEV. If you would like to use Lando, use the "Contribute without create project" steps below.

You will be prompted to select the version of Sous you want to install. The main versions are:

Sous with Layout Builder
Sous with Paragraphs

Both of these versions include Emulsify as the default theme in addition to a Gin admin and our recommended security, performance and admin modules.

Important last step: Unpacking

Recipe dependencies need to be unpacked to the root composer.json file. This feature is currently under development in Drupal core. In the meantime, you will need to run this command for every recipe in web/recipes:

php /usr/local/bin/composer unpack "$recipe_full_package_name

Eg: php /usr/local/bin/composer unpack fourkitchens/sous-layout-builder

This will move all of the dependencies into the root and remove that recipe from web/recipes.

Working with Emulsify

The Emulsify theme is installed as part of this project.

Additional Tooling

This package provides some additional tooling to support the build.

Helper scripts

To use the helper script provided you will need to have npm installed. Then just run npm run <command>. For example: npm run import-data. These commands are bash scripts located in the ./scripts/sous directory and defined in package.json.

Configuration management scripts

confex

npm run confex

Export active configuration to the config directory.

confim

npm run confim

Import the configuration to the database.

import-data

npm run 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

npm run local-data-bak

Create a local database backup. Saves the backup to the ./reference directory.

rebuild

npm run rebuild

Rebuild a fresh local instance of your site. Imports the canonical database backup and imports configuration into it.

setup

npm run setup

This is run during the installation process of composer create project.

theme-build

npm run theme-build

Builds the emulsify based theme.

theme-watch

npm run theme-watch

Used for theme development.

Semantic Versioning

Setup

This repo has the following named/maintenance branches:

main
x.x
x.x.x

These branches are protected on GitHub
A personal access token was created for CircleCI.
CircleCI was setup to run on this project and tag the releases
Commit changes following the Conventional commit guidelines
Push your change up and verify CircleCI passes and has run on your desired branch.

Troubleshooting

Your branch must be a named stable release branch in order to get a tag.
Prereleases are not supported with this package because they contain a dot.

Contributing

The composer command can be adjusted to account for a new branch you're working on.

composer create-project fourkitchens/sous-drupal-project:dev-[branch-name] PROJECT_NAME

Contribute without create-project

To run setup + install:

clone repo gh repo clone fourkitchens/sous-drupal-project [directory]
cd to your project directory
copy /.devops/environment/example.local.env to /.devops/environment/local.env
choose environment: add local_dev="ddev" or local_dev="lando" to /.devops/environment/local.env
composer install
composer run-script post-create-project-cmd (Requires composer to be installed locally. i.e. outside lando)

Contribute to recipes

Follow the steps above, and choose [0] Default Sous (media and content types only) option when presented with the recipe dialogue in the setup script
Composer require the recipe using --prefer-source. Optionally specify a branch.
The recipe will be added to the /recipes directory. Make changes there and push to your branch.
Make desired changes to sous and export config. Compare the config in the /config/default directory to the config in the recipe. You may be able to replace the config in the recipe, or you may need to apply config actions.
Test your recipe by running "ddev install-recipe [recipe-name]" or "lando install-recipe [recipe-name]"

[TODO] Add more information on updating recipe config and config actions.

Current recipes in Sous

[TODO] Add recipes here.

To install recipes, use the lando install-recipe command. Eg. For the paragraphs version of Sous, run:

lando install-recipe fourkitchens/sous-paragraphs

fourkitchens / sous-drupal-project

Maintainers

Details