General tips

The following are tips and tricks that developers have found while working on the project.

SSL

You can trust the Lando cert by following the steps here: https://docs.lando.dev/core/v3/security.html#certificates

This will avoid you getting SSL warnings when browsing localhost.

You can then launch the UI within windows directly (e.g. node_modules/.bin/cypress open or gedit ...).

Xdebug

Xdebug can be turned on via lando xdebug-on - this is auto-starting for debug only. Turn it off again with xdebug-off

Xdebug can be set to trigger mode (using a browser extension such as Xdebug helper) by using xdebug-trigger. It is turned off using the same xdebug-off. Using the trigger you can also utilise trace and profile modes, although CLI usage or any API calls need manual triggering.

The path mapping for PHPStorm is project root -> /app

Stuck Config Options

If your changes to .env or config values do not seem be taking effect, and lando clear doesn't resolve the issue you may need to restart your containers with lando stop and then lando start.

Frontend error "Error: Cannot find module" during theme compilation.

When creating new Vue components with the npm watcher on, you may receive an error "cannot find module ~YourModule/Components/YourComponent.vue", even though the file exists at the given path. You just need to restart the watcher.

Logs (Log viewer)

This project uses Log viewer to view log files. Using this you can browse all logs via a nice UI, see /log-viewer (you must be logged in as a superuser)

See config/log-viewer.php for configuration options.

Generating HTML docs from README's

The easiest way to do this is via the Pandoc package. On linux this can be installed via apt install pandoc.

Then you can do something like this to concatenate all module readmes into a single html file (that can be imported to Google Docs)

pandoc ./Modules/*/README.md -o ./public/all-module-docs.html

Force enable vue dev tools in production build

If you want to debug and enable vue dev tools in a production build, you can do so by following the article here: Enable dev tools.