Local development¶
Docker setup¶
Requirements¶
In order to run local development you need:
go-task- Docker
- Preferably support for
VIRTUAL_HOSTenvironment variables for Docker containers. Examples: Dory (OSX) ornginx-proxy.
MacOS and Docker¶
If you are using MacOS, you can use the standard "Docker for Mac" app, however there has been developers that have experienced it acting slow.
Alternatively, you can use Orbstack, which is a direct replacement for Docker for Mac, but is optimized to run much faster.
Docker for Mac¶
If you do end up using Docker for Mac, it is recommended to use VirtioFS on the mounted volumes in docker-compose, to speed up the containers.
Howtos¶
Enable XDebug¶
Prerequisites:
- An IDE with support for XDebug e.g. JetBrains PhpStorm
- Optionally: A browser extension to activate XDebug
For performance reasons XDebug is disabled by default. It can be enabled temporarily through a task:
- Run
task dev:enable-xdebug - Validate that XDebug is enabled by inspecting http://dpl-cms.docker/admin/reports/status/php. It should contain extended information about XDebug
- Debug the application by setting breakpoints, listen for incoming connections in your IDE and activate XDebug from you client/browser
- When you are finished, hit
enterin the terminal where you enabled XDebug. This will disable XDebug
Download database and files from Lagoon¶
Retrieve the latest backup of database and files from Lagoon¶
Prerequisites:
- A connected Lagoon CLI
jqinstalled locally
Run the following command to retrieve the latest backup of database and files from a Lagoon project:
Copy a specific database snapshot from Lagoon environment to local setup¶
Prerequisites:
- Login credentials to the Lagoon UI, or an existing database dump
The following describes how to first fetch a database-dump and then import the dump into a running local environment. Be aware that this only gives you the database, not any files from the site.
- To retrieve a database-dump from a running site, consult the "How do I download a database dump?" guide in the official Lagoon. Skip this step if you already have a database-dump.
- Place the dump in the restore/database directory, be aware
that the directory is only allowed to contain a single
.sqlfile. - Start a local environment using
task dev:reset - Import the database by running
task dev:restore:database
Copy a specific snapshot of files from Lagoon environment to local setup¶
Prerequisites:
- Login credentials to the Lagoon UI, or an existing nginx files dump
The following describes how to first fetch a files backup package and then replace the files in a local environment.
If you need to get new backup files from the remote site:
- Login to the lagoon administration and navigate to the project/environment.
- Select the backup tab:
- Retrieve the files backup you need:
4. Due to a UI bug you need to RELOAD the window and then it should be possible
to download the nginx package.
Replace files locally:
- Place the files dump in the files-backup directory, be aware
that the directory is only allowed to contain a single
.tar.gzfile. - Start a local environment using
task dev:reset - Restore the filesš by running
task dev:restore:files
Get a specific release of dpl-react - without using composer install¶
In a development context it is not very handy only to be able to get the latest version of the main branch of dpl-react.
So a command has been implemented that downloads the specific version of the assets and overwrites the existing library.
You need to specify which branch you need to get the assets from. The latest HEAD of the given branch is automatically build by Github actions so you just need to specify the branch you want.
It is used like this:
Example: