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.
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.
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]
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.
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.
The Emulsify theme is installed as part of this project.
This package provides some additional tooling to support the build.
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.
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.
- 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.
- 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.
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
To run setup + install:
- clone repo
gh repo clone fourkitchens/sous-drupal-project [directory] cdto your project directory- change the name of your project in .lando.yml
lando startcomposer installcomposer run-script post-create-project-cmd(Requires composer to be installed locally. i.e. outside lando)
To install recipes, use the lando install-recipe command. Eg. For the paragraphs version of Sous, run:
lando install-recipe fourkitchens/sous-paragraphs