https://github.com/patrickcate/drupal-cleanroom

Drupal 9 boilerplate repo to more easily setup environments for use with Composer, Lando, and VSCode. Mainly used for testing modules, themes, patches.
https://github.com/patrickcate/drupal-cleanroom

Last synced: about 1 month ago
JSON representation

Drupal 9 boilerplate repo to more easily setup environments for use with Composer, Lando, and VSCode. Mainly used for testing modules, themes, patches.

• Host: GitHub
• URL: https://github.com/patrickcate/drupal-cleanroom
• Owner: patrickcate
• License: cc0-1.0
• Created: 2021-03-21T03:19:55.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-25T13:33:01.000Z (over 2 years ago)
• Last Synced: 2024-11-11T23:08:54.115Z (3 months ago)
• Homepage:
• Size: 13.7 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Drupal Cleanroom

Drupal 9 boilerplate repo to more easily setup environments for use with Composer, Lando, and VSCode.

Mainly used for testing modules, themes, patches.

## Installation

From the terminal:

1. Clone repo to new folder: `git clone [email protected]:patrickcate/drupal-cleanroom.git MY_FOLDER_NAME`

2. Move into the new directory: `cd MY_FOLDER_NAME`

3. Remove the git repo: `rm -rf .git`

   - Create a new git repo for the project with `git init` if needed.

4. Change the `APP_NAME_PLACEHOLDER` app name in `.lando.yml` to something more relevant.

   - Example: `printf '%s\n' ',s/APP_NAME_PLACEHOLDER/my-awesome-app/g' w q | ed .lando.yml`

5. Run `lando start`

6. Run `lando composer install`

7. Run `lando drush site:install --db-url=mysql://drupal9:drupal9@database/drupal9 --account-pass=admin`

## Run PHP Unit Tests

### With Xdebug

1. Start `PhpUnit` debugger in VSCode.

2. Run: `lando phpunitdebug web/PATH_TO_TEST_FILE.php`

### Without Xdebug

Run: `lando phpunit web/PATH_TO_TEST_FILE.php`

## Run Xdebug

Start `Listen for XDebug` debugger in VSCode.