Skip to content

Commit c38be4f

Browse files
committed
Improve setup documentation instructions in README.md after a successful installation
1 parent 3483637 commit c38be4f

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,35 @@
44

55
This is an example project demonstrating how to set up a Drupal CMS based environment on Lagoon.
66

7-
When running on a Lagoon instance, the first time that the project starts up, it will attempt to install Drupal-CMS - see the `.lagoon.yml` file for how this is achieved using a post rollout task.
7+
When running on a Lagoon instance, the first time that the project starts up, it will attempt to install Drupal CMS - see the `.lagoon.yml` file for how this is achieved using a post rollout task.
88

99
The `./.lagoon/scripts/scaffold.sh` script plays a key role in setting up the project, ensuring necessary dependencies and configurations are applied when running locally versus within Lagoon. See the file and the Dockerfile to see how this is achieved.
1010

1111
## Local Development
1212

1313
### How to Run Locally
1414

15-
To set up and run the project locally, execute the following commands:
15+
To set up and run the project locally, after ensuring docker is running, execute the following commands:
1616

1717
```sh
18+
pygmy up
1819
docker compose build
1920
docker compose up -d
2021
docker compose exec cli bash -c 'wait-for mariadb:3306'
21-
docker compose exec cli bash -c 'drush -y si && drush -y cr'
22+
docker compose exec cli bash -c 'drush -y si && drush -y cr && drush uli'
2223
```
2324

25+
(ignore the warnings referring to block plugins not being found.
26+
This is a known issue which will be fixed with this https://www.drupal.org/project/drupal/issues/3478773#comment-16090318)
27+
28+
2429
These commands will:
2530

26-
1. Build the necessary Docker containers.
27-
2. Start the containers in detached mode.
28-
3. Wait for the MariaDB service to become available.
29-
4. Install Drupal and rebuild the cache using Drush.
31+
1. Start Pygmy.
32+
2. Build the necessary Docker containers.
33+
3. Start the containers in detached mode.
34+
4. Wait for the MariaDB service to become available.
35+
5. Install Drupal and rebuild the cache using Drush.
3036

3137
### Using the Project Browser to install modules (Only Usable When Running Locally)
3238

0 commit comments

Comments
 (0)