https://github.com/localgovdrupal/localgov_microsites_project
Project template for Drupal sites built with the LocalGov Drupal Microsites distribution.
https://github.com/localgovdrupal/localgov_microsites_project
Last synced: 9 months ago
JSON representation
Project template for Drupal sites built with the LocalGov Drupal Microsites distribution.
- Host: GitHub
- URL: https://github.com/localgovdrupal/localgov_microsites_project
- Owner: localgovdrupal
- License: gpl-2.0
- Created: 2022-04-19T11:46:26.000Z (about 4 years ago)
- Default Branch: 4.x
- Last Pushed: 2025-04-08T11:46:26.000Z (about 1 year ago)
- Last Synced: 2025-04-08T12:36:31.954Z (about 1 year ago)
- Language: PHP
- Homepage: https://localgovdrupal.org/products/microsites
- Size: 114 KB
- Stars: 7
- Watchers: 6
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LocalGov Drupal Microsites Composer project template
This project template provides a starter kit for managing your LocalGov Drupal Microsites dependencies with [Composer](https://getcomposer.org/).
Please note that this is a separate distribution from LocalGov Drupal.
For more information on the Localgov Microsites install profile, please see https://github.com/localgovdrupal/localgov_microsites
For more information on the LocalGov Drupal install profile, please see https://github.com/localgovdrupal/localgov
## Usage
First you need to [install Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx).
After that you can create the project:
```shell
composer create-project --stability stable localgovdrupal/localgov_microsites_project:^4.0 MY_PROJECT --no-install
```
## Using Lando
If using Lando, you can then boot up Lando and run the site install
```shell
cd MY_PROJECT
lando start
lando composer install
lando drush si localgov_microsites -y
```
## Using DDEV
If using ddev, you can then boot up ddev and run the site install
```shell
cd MY_PROJECT
ddev start
ddev composer install
ddev drush si localgov_microsites -y
```
## Using host machine
If you're working directly on your host machine, you'll still need to run the composer install.
```shell
cd MY_PROJECT
composer install
drush si localgov_microsites -y
```
## Running PHPUnit tests in Lando
The included phpunit.xml.dist file contains configuration for automatically
running the LocalGov Drupal test suite.
The default .lando.dist.xml includes environment variables for:
```bash
BROWSERTEST_OUTPUT_DIRECTORY: '/app/web/sites/simpletest/browser_output'
BROWSERTEST_OUTPUT_BASE_URL: 'https://localgov-micro.lndo.site'
```
To allow html output, manually create a directory for browser output.
```bash
mkdir web/sites/simpletest/browser_output
```
To run all LocalGov Drupal tests from Lando:
```bash
lando ssh
phpunit
```
To run all the tests for a specific module:
```bash
lando ssh
phpunit web/modules/contrib/localgov_my_module
```
Tests can be filtered using the `--filter` option. To only run a specific test:
```bash
lando ssh
phpunit --filter=myTestName
```
## Running PHPUnit tests in DDEV
The included phpunit.xml.dist file contains configuration for automatically
running the LocalGov Drupal test suite.
The default .ddev/config.yml includes configuration for some extra domains that
ddev and phpunit will need to resolve different microsite domains.
When ddev starts, it will attempt to write these to /etc/hosts
If DDEV cannot write to /etc/hosts, you may need to add these manually.
If you are having problems runnign phpunit tests in DDEV, try adding the
following to `/etc/hosts`
```
127.0.0.1 group-1.web group-2.web group-3.web group-4.web group-5.web
```
To allow html output, manually create a directory for browser output.
```bash
mkdir web/sites/simpletest/browser_output
```
To run all LocalGov Drupal tests from inside DDEV:
```bash
ddev ssh
phpunit
```
To run all the tests for a specific module:
```bash
ddev ssh
phpunit web/modules/contrib/localgov_my_module
```
Tests can be filtered using the `--filter` option. To only run a specific test:
```bash
ddev ssh
phpunit --filter=myTestName
```
## Maintainers
This project is currently maintained by:
- Ekes: https://www.drupal.org/u/ekes
- Finn Lewis: https://www.drupal.org/u/finn-lewis
- Stephen Cox: https://www.drupal.org/u/stephen-cox