README

Sous Project

A Drupal starter with Gin administration, an Emulsify theme and Composer recipes. Sous prepares the project; your site owns its code, dependencies and configuration.

Features and Configurations

Choose the content model during installation. Every choice includes Gin administration, Emulsify, Media, text formats, dashboards, Config Split, a publishing workflow, Dev Tools and SEO. Paragraphs and Layout Builder also include Content List and Gallery.

Choice	Content setup
`0` Admin only	Administration and theme without Page or Frontpage
`1` Paragraphs	Page and Frontpage with Layout Paragraphs components, Content List and Gallery
`2` Layout Builder	Page and Frontpage with native layouts and text, media, Accordion, Tabs, Quote, Embed, Table, Content List and Gallery blocks

The package index advertises optional recipes such as Events, News Post, Profile, Alerts and Search. The installer applies the included components and their matching integrations after the optional sides, so they can extend the Content fields the sides create. Admin only includes neither component. Dev Tools adds Devel, Stage File Proxy and Masquerade locally. Paragraph Types belongs to the Paragraphs main course. See features and configurations for the site's building blocks.

Installation

Dependencies and Requirements

PHP 8.4 and Composer 2
DDEV, Docker and Git
Node.js from .nvmrc on your computer

composer create-project fourkitchens/sous-drupal-project:^8.0 PROJECT_NAME
cd PROJECT_NAME

Answer the content, optional recipe, CI and dessert questions before installation starts. Dessert offers Emulsify UI Kit, a custom component library or None. For an unattended install, set every answer:

SOUS_CONTENT=layout-builder SOUS_RECIPES=sous-events,sous-news-post \
  SOUS_CI=gitlab SOUS_LIBRARY=none \
  composer create-project fourkitchens/sous-drupal-project:^8.0 PROJECT_NAME

SOUS_CONTENT accepts admin-only (0), paragraphs (1) or layout-builder (2). SOUS_CI accepts circleci, github, gitlab or none (0–3). Set SOUS_RECIPES='' for no extras, or supply names separated by spaces or commas. SOUS_LIBRARY accepts none (default), ui-kit or an Emulsify-compatible Git URL ending in .git. SOUS_LIBRARY_REF optionally selects a branch or tag; custom repositories otherwise use their default branch. The installer checks the library ref before it starts setting up the site. The final order summary shows the local URL and a generated password for sous_chef; UID 1 stays blocked.

If a fresh install fails partway through, keep the partial directory for troubleshooting and fix the reported error. Run composer create-project again in a fresh directory with a different name so DDEV creates a separate database. To reuse the original name, remove the failed DDEV project and move the partial directory aside first. The installer starts from a fresh database and theme scaffold on each run.

Recipe Dependency Management

Sous packages publish independent Composer recipes. Drupal's Composer plugin unpacks recipe dependencies when Composer requires a recipe. The installer applies the recipes once, then removes their source directories and the setup repository. The site owns the resulting dependencies and configuration. See adding a recipe for later additions.

Working with Emulsify

Installation generates a project-named Emulsify theme, sets it as the frontend default and installs its npm dependencies. Selecting a component library also installs it and compiles the theme; None leaves the scaffold ready for later. See Build Tools.

Additional Tooling

Helper scripts

Run npm run <command> through the shell scripts in devops/scripts/. Shared Drupal commands use DDEV locally and installed tools in CI or on hosts; Node tools run directly. Setup, rebuild, database import and backup remain local DDEV commands.

Command	Purpose
`npm run setup`	Prepare a fresh clone, build available theme sources and restore its database
`npm run rebuild`	Reset a branch's database and deploy configuration
`npm run confex` / `npm run confim`	Export configuration / run Drush deploy
`npm run import-data` / `npm run local-data-bak`	Import or back up the local database

See Local Setup, Build Tools and Deployment.

Semantic Versioning

Conventional Commits drive releases from main. Generated sites use v-prefixed GitHub or GitLab releases; Sous retains its unprefixed tags. See release setup.

Contributing

Use Conventional Commits and review guidance. Read the maintainer guide before changing Sous or its recipes.

GPL-2.0-or-later; upstream packages retain their own licenses and notices.

fourkitchens / sous-drupal-project

Package info

Security

Statistics