kalamuna/kalaconfig

Provides a base set of configuration and module dependencies for starting new Drupal projects.

Installs: 1 991

Dependents: 0

Suggesters: 0

Stars: 1

Watchers: 13

Forks: 0

Open Issues: 0

Type:drupal-module

1.x-dev 2018-08-13 22:36 UTC

README

Kalaconfig provides some configuration and module dependencies for starting new Drupal projects, including three config split environments—dev, test, and live.

Note: This module automatically uninstalls itself immediately after installation. But do not remove it! Composer dependencies are still needed.

Usage

  1. Merge the following snippet into your project's composer.json file so that drupal-library and component dependencies install to the correct location:

    "extra": {
        "installer-types": ["component"],
        "installer-paths": {
            "web/libraries/{$name}": [
              "type:component",
              "type:drupal-library"
            ]
        }
    }
    

    where web/libraries/ is the path to your libraries directory relative to your project root. Take care not to wipe out any of the existing extra and installer-paths settings that may already exist in your composer.json.

  2. Run composer require kalamuna/kalaconfig on your main project.

  3. Run composer install on your main project.

  4. Turn on your local development environment (e.g., vagrant up to use the built-in DrupalVM)

  5. Install Drupal with core "standard" installation profile.

  6. Remove the $settings['install_profile'] = 'standard' line automatically appended to settings.php by the Drupal install process.

  7. Enable this module; it will set up a sane Config Split scheme, automatically export your initial configs, and then uninstall itself.

  8. Commit the newly-exported configuration files to your repository, and push them to origin.

  9. Use the config_installer installation profile to create the sites in all other environments (drush site-install config_installer).

Notes

You may choose not to install dev dependencies in your production/testing/staging environments (recommended) by using composer install --no-dev. However, that means the dependencies brought in by Kalaconfig will be missing in those environments. Therefore, you must remember to copy any dependencies provided by Kalaconfig that are needed in those environments into your main project's composer.json require section.