project phpedu-project

dakala/phpedu-project

Project template for Drupal 8 sites built with the PhpEdu distribution.

This is a Composer-based installer for the PhpEdu Drupal distribution., _(*1)

Get Started

You will need the following installed:, _(*2)

• Composer, obviously
• Node, which includes the NPM package manager

When you have those, run this command:, _(*3)

$ composer create-project dakala/phpedu-project:8.x-dev MY_PROJECT --no-interaction

Composer will create a new directory called MY_PROJECT containing a docroot directory with a full PhpEdu code base therein. You can then install it like you would any other Drupal site., _(*4)

Maintenance

Use this table as your guide to maintaining your code base with Composer:, _(*5)

Composer is a dependency manager. If module foo-8.x-1.0 depends on baz-8.x-3.2, Composer will not let you update baz to 8.x-3.3 (or downgrade it to 8.x-3.1, for that matter)., _(*6)

Composer is only responsible for maintaining the code base., _(*7)

Source Control

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. This might be a bit disconcerting if you're newly arrived from Planet Drush, but in a Composer-based project like this one, you SHOULD NOT commit your installed dependencies to source control., _(*8)

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., _(*9)