installation.md

Local installation of Frontkom Drupal projects

Short version (for projects with default setup and ddev setup)

1. Clone the repository
2. Start project with ddev (ddev start)
3. Install dependencies (ddev composer install)
4. Install the project (ddev composer site-install)

Longer version

Configure the codebase to be able to install

Frontkom policy makes it impossible (well, hard) to accidentally run a site install command on a codebase. The reason for this is so no-one would accidentally run it on an environment that is in use (i.e staging or production). The only exclusion to this rule is if the project has actively been marked as a development environment. We do this by placing the following in settings.local.php:

$settings['environment'] = 'development';

Run composer install

Even though this will also run as part of composer site-install, it might be useful to run this first, to make sure scaffolding is in place, and some packages might be needed as part of environment checks in composer site-install.

(optional) Enter the database settings into settings.local.php

If your local development setup makes this easier, you can now add your local database settings to settings.local.php. You can also skip this if you want to pass the database settings as part of the site install command below.

Run the composer site-install command

If you have database settings defined in settings.php, you can now simply run this command:

composer site-install

You can also pass along the database settings to this command, and it will be added to settings.local.php automatically. As an example, if you have a database available at localhost, with the default port, and the user is root and the password is root. And you want your database to be named mydb. Then run this as the command:

DB_PARAMS="--db-url=mysql://root:root@localhost/mydb" composer site-install