README

Composer project template for building a new site on the Accessible Media (AccMe) Analytics distribution (the accme_analytics install profile). Modeled on drupal/recommended-project -- the standard "relocated document root" layout used by most Drupal project templates -- with the profile itself added as a required package.

Getting started

composer create-project messageagency/accme-analytics-starter my-site
cd my-site

This scaffolds a full Drupal codebase under web/, with the profile installed at web/profiles/contrib/accme_analytics.

Handle credentials before you install

The profile's interactive install form can collect a YouTube API key and Vimeo API credentials directly -- convenient, but those values get written into regular config, which normally ends up in config/sync/ and gets committed to git. For anything beyond a one-off local throwaway site, set these up first instead:

1. Append the values from example.settings.php to your web/sites/default/settings.php.
2. Set the environment variables listed in .env.example through whatever your environment already uses for that (Lando/DDEV env vars, your hosting platform's environment settings, your CI/CD secrets store, etc.) -- .env.example is a reference list of variable names, not a file PHP loads automatically.

See the comments in example.settings.php for the full explanation of why this matters and exactly which config keys it overrides.

Install the site

vendor/bin/drush site-install accme_analytics

Leave the YouTube/Vimeo/Okta fields on the install form blank if you've already set up settings.local.php as above -- the environment-sourced values will take effect regardless of what (if anything) is stored in config.

What's in this template

• composer.json -- the project's package requirements, Composer plugin config, and scaffold/installer-paths configuration. Notably includes "enable-patching": true under extra, which cweagans/composer-patches requires before it will pick up any patches declared by dependencies (including the ones the accme_analytics profile itself declares) -- easy to miss, and patches silently don't apply without it.
• .gitignore -- ignores vendor/, Composer-managed contrib code under web/, and anything that could hold real secrets (settings.local.php, .env).
• .editorconfig -- Drupal's standard editor normalization rules.
• .env.example -- the environment variable names example.settings.local.php expects.
• example.settings.local.php -- see above.