Skip to content

Improve / fix setup documentation instructions in README.md after a successful installation #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ChandeepKhosa wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −7
Open

Improve / fix setup documentation instructions in README.md after a successful installation #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,35 @@

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

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.
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.

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.

## Local Development

### How to Run Locally

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

```sh
pygmy up
docker compose build
docker compose up -d
docker compose exec cli bash -c 'wait-for mariadb:3306'
docker compose exec cli bash -c 'drush -y si && drush -y cr'
docker compose exec cli bash -c 'drush -y si && drush -y cr && drush uli'
```

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


These commands will:

1. Build the necessary Docker containers.
2. Start the containers in detached mode.
3. Wait for the MariaDB service to become available.
4. Install Drupal and rebuild the cache using Drush.
1. Start Pygmy.
2. Build the necessary Docker containers.
3. Start the containers in detached mode.
4. Wait for the MariaDB service to become available.
5. Install Drupal and rebuild the cache using Drush.

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

Expand Down