├── .gitignore ├── composer.json └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore binaries. 2 | /bin 3 | 4 | # Ignore non-custom parts of Drupal. 5 | /docroot/core 6 | /docroot/modules/contrib 7 | /docroot/profiles/contrib 8 | /docroot/themes/contrib 9 | /docroot/sites/default/files 10 | 11 | # Ignore Composer-managed dependencies. 12 | vendor/ 13 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "acquia/reservoir-project", 3 | "description": "Project template for Drupal 8 sites built with the Reservoir distribution.", 4 | "type": "project", 5 | "license": "GPL-2.0-or-later", 6 | "minimum-stability": "dev", 7 | "prefer-stable": true, 8 | "repositories": [{ 9 | "type": "composer", 10 | "url": "https://packages.drupal.org/8" 11 | }], 12 | "require": { 13 | "composer/installers": "^1.0", 14 | "cweagans/composer-patches": "~1.0", 15 | "drupal-composer/drupal-scaffold": "^2.0.0", 16 | "acquia/reservoir": "1.0.0-alpha4" 17 | }, 18 | "extra": { 19 | "installer-paths": { 20 | "docroot/core": [ 21 | "type:drupal-core" 22 | ], 23 | "docroot/modules/contrib/{$name}": [ 24 | "type:drupal-module" 25 | ], 26 | "docroot/profiles/contrib/{$name}": [ 27 | "type:drupal-profile" 28 | ], 29 | "docroot/themes/contrib/{$name}": [ 30 | "type:drupal-theme" 31 | ], 32 | "drush/contrib/{$name}": [ 33 | "type:drupal-drush" 34 | ] 35 | }, 36 | "enable-patching": true 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Reservoir - Drupal distribution](https://raw.githubusercontent.com/acquia/reservoir-project/assets/reservoir.png) 2 | 3 | # Reservoir: Composer installer 4 | 5 | This is a Composer-based installer for the [Reservoir](https://github.com/acquia/reservoir) Drupal distribution. 6 | 7 | --- 8 | 9 | ## Get started 10 | ``` 11 | $ composer create-project acquia/reservoir-project MY_PROJECT --stability=alpha 12 | ``` 13 | Composer will create a new directory called `MY_PROJECT` containing a `docroot` directory with a full Reservoir codebase therein. 14 | 15 | ## Source control 16 | If you peek at the `.gitignore` we provide, you'll see that certain directories, including all directories containing contributed projects, are excluded from source control. 17 | 18 | When you set up the project, Composer will create a file called `composer.lock`, which is a list of which dependencies were installed and in which versions. **Commit `composer.lock` to source control!** Then, when your colleagues want to spin up their own copies of the project, all they'll have to do is run `composer install`, which will install the correct versions of everything in `composer.lock`. 19 | --------------------------------------------------------------------------------