workbc-main

This is the WorkBC site on Drupal.

Development

Initial setup

• Copy .env.example to .env
• Start the environment: docker-compose up
• Adjust folder permissions:
  • mkdir src/private && docker-compose exec php sudo chown www-data /var/www/html/private
  • docker-compose exec php sudo chown www-data /var/www/html/config/sync
• Import the init data dumps:
  • bunzip2 -c src/scripts/workbc-init.sql.bz2 | docker-compose exec -T postgres psql -U workbc workbc
  • bunzip2 -c src/scripts/ssot-full.sql.bz2 | docker-compose exec -T postgres psql -U workbc ssot && docker-compose kill -s SIGUSR1 ssot
• Create the Solr index:
  • docker-compose exec -u 0 solr sh -c "chown -R solr:solr /opt/solr/server/solr/workbc_dev"
  • docker-compose exec solr sh -c "curl -sIN 'http://localhost:8983/solr/admin/cores?action=CREATE&name=workbc_dev&configSet=workbc&instanceDir=workbc_dev'"
  • docker-compose exec php bash -c "drush sapi-r && drush sapi-i"
• Edit your hosts file to add the following line:

127.0.0.1       workbc.docker.localhost

• Run the sync script: docker-compose exec php scripts/sync.sh
• Open http://workbc.docker.localhost:8000/ to view the site and login as admin (obtain the password from your admin)
• Open http://localhost:8080/ to view the SSoT API

For Windows users, you need a version of Windows that is able to run Docker using Hyper-V backend, e.g. Windows 10 Pro. When running a command above in PowerShell, you may need to wrap it using cmd /c "command".

Updating local dev environment after git pull

make sync from the src/ folder should perform any post-pull actions needed or run the sync script directly: docker-compose exec php scripts/sync.sh

In some situations drush cim fails. In this case, the Drupal Admin UI should work. If errors still persist, you may need to manually enable new modules before running the configuration synchronization with drush en module.

Updating local dev environment from a deployment stage

You may want to get the latest data from a deployment stage (DEV, TEST or PROD). In that case, follow these steps:

• Delete all your local workbc database tables (e.g. using a database manager such as the excellent DBeaver)
• Import the init data dump bunzip2 -c src/scripts/workbc-init.sql.bz2 | docker-compose exec -T postgres psql -U workbc workbc
• Download a fresh dump from your desired stage via Backup/Migrate module at https://<stage>.workbc.ca/admin/config/development/backup_migrate and select Backup Source Default Drupal Database
• Restore the fresh dump on your local at http://workbc.docker.localhost:8000/admin/config/development/backup_migrate/restore
• Repeat the above two steps for Backup Source Public Files Directory in case you also need the latest files

Installing modules

From within the php container:

• Execute the composer requires command for the module. The module project page on Drupal.org provides this command, e.g. composer require 'drupal/devel:^4.1'
• Enable the module using drush en module or via the Drupal Admin UI.
• Export updated configuration to the /var/www/html/config/sync folder using drush cex

Backup / restore

This repo includes a patched version of Backup and Migrate that supports PostgreSQL using the native pg_dump and psql tools. You can backup and restore both the Drupal and the SSoT databases using the module.

Theming / styling

Please see the src/web/themes/custom/workbc/README.md for more details.

Make and development shortcut commands

This project includes a Makefile, which has been configured with a few command shortcuts to help forgetful developers (like me!) more easily manage all the different CLI tasks they might want to do.

From your host machine, in the src/ directory, run make <command>:

Docker related:

1. up
2. down
3. start
4. stop
5. prune
6. ps

Drupal related:

1. shell
2. sync
3. drush <command>
4. navrebuild

SCSS related:

1. compilescss
2. watchscss

For Windows users, follow this guide on StackExchange to install and configure Make for Windows.

Troubleshooting

• If you run into timeout issues while installing/unzipping PHP, try the following:
  • docker-compose exec php composer config --global process-timeout 600
  • docker-compose exec php composer install --prefer-dist --no-dev
  • There as also one instance where making sure you were logged into docker helped (docker login or logging in via the UI)