> For the complete documentation index, see [llms.txt](https://docs.morpht.com/convivial-gov/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.morpht.com/convivial-gov/getting-started.md).

# Getting started

### Quick Start with DDEV

```bash
mkdir my-drupal-site && cd my-drupal-site
ddev config --project-type=drupal11 --docroot=web
ddev start
ddev composer create-project drupal/cms
ddev composer require drupal/convivial_gov
ddev launch
```

### What the Recipe Provides

The Convivial recipe transforms a base Drupal CMS installation into a full-featured publishing platform. After installation, you get:

* **Content Model** - Pre-configured content types for pages, articles, events, resources, people, alerts, sections, and supporting taxonomies
* **Page Building** - Canvas-powered drag-and-drop page composition with 40+ components including heroes, cards, accordions, stats, grids, and sliders
* **Theming** - Morphos, a Tailwind CSS 4 theme with DaisyUI, offering extensive palette and layout customisation
* **Editorial Workflows** - Content moderation with draft, review, and published states, plus scheduled publishing
* **Media Management** - Full media library with images, documents, videos (local and remote), SVG support, and focal point cropping
* **SEO & Accessibility** - Metatags, XML sitemaps, URL aliases, Yoast SEO analysis, and accessibility auditing via Editoria11y
* **Forms & Email** - Webform integration and Easy Email for transactional messaging
* **Automation** - ECA (Event-Condition-Action) rules engine for content workflows
* **AI Integration** - Ready for Anthropic and OpenAI providers through the Drupal AI module
* **Admin Experience** - Gin admin theme, Coffee quick navigation, and a customisable dashboard

### Applying to an Existing Drupal Site

Convivial can be applied to an existing Drupal 11 installation, though results depend on how much the current configuration overlaps with what the recipe expects. Since recipes don't provide update paths, applying to a site with existing content types or configuration may require manual reconciliation.

```bash
composer require morpht/convivial_gov
drush site:recipe recipes/convivial_gov
```

> **Note:** Review the recipe's module list in `recipes/convivial_gov/recipe.yml` before applying. Some modules (e.g. `friendly captcha`, `klaro`) may require API keys or additional configuration after installation.

### Next Steps

* Log in as administrator and explore the Dashboard
* Create your first Page using Canvas to see the component library in action
* Visit **Appearance → Morphos → Settings** to configure palettes and layout options
* Review the content types under **Structure → Content types** to understand the content model
* Check **Configuration → Workflows** to see the editorial moderation setup