From 096f617b8ba0721fce50c097ca435647fb86afe8 Mon Sep 17 00:00:00 2001 From: Oliver Davies Date: Thu, 29 Oct 2020 12:13:25 +0000 Subject: [PATCH] Document custom DDEV commands in README Fixes #266 --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 55f5009..2b44b9e 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,29 @@ Production settings files are generated automatically during a deployment. This [drupal_settings_files]: https://galaxy.ansible.com/opdavies/drupal_settings_files +## Local development + +Local development is done using [DDEV-Local](https://www.ddev.com/ddev-local). + +### Custom DDEV commands + +#### Drupal + +| Command | Description | +| --- | --- | +| `ddev app install` | Install the site based on the existing config | +| `ddev app refresh` | Re-import the existing config and rebuild cache | + +#### Front-end + +| Command | Description | +| --- | --- | +| `ddev theme build` | Compile a production (minified and purged) version of the theme's CSS and JS | +| `ddev theme dev` | Compile a development version of the theme's CSS and JS | +| `ddev theme install` | Install the node dependencies for the theme | +| `ddev theme ssh` | SSH into the theme directory within the web container | +| `ddev theme watch` | Compile a development version of the theme's CSS and JS, and watch for changes | + ## Migrating data into the website To view the status of all the migrations: