Aljibe (ddev-aljibe) is an add-on for DDEV for Drupal projects that adds several tools in a simple and fast way, leaving a new project ready for development in a few minutes.
Aljibe sits on top of DDEV and adds some containers, configuration and commands to make the development of Drupal projects faster and easier.
Warning
Aljibe is still in Alpha stage!
- Behat: BDD and Acceptance testig
- BackstopJS: Visual regression testing
- Lighthouse: Audit website quality
- Pa11y: Accesibility checks
- MkDocs: Documentation wiki
- And more...
Create a folder for your new project (e.g. mkdir my-new-project)
Configure a basic ddev project:
ddev config --auto
Install the Aljibe addon. This will install all the dependant addons too:
ddev get metadrop/ddev-aljibe
Launch Aljibe Assistant. This will guide you throught the basic Drupal site instalation process:
ddev aljibe-assistant
You are ready! you will have a new Drupal project based on Aljibe ready for development.
Once the project has been created and uploaded to version control, anyone else working with it can clone it and with the following command you can have the project ready to work with.
ddev setup [--all] [--no-install] [--no-themes]
If you have a multisite instalation, you can install only one site by running:
ddev site-install <site_name>
If you need to create a secondary database, you can run:
ddev create-database <db_name>
NOTE: This command will create a database accesible with the same user and password from the main one. If you want to persist this across multiples setups, you can add this command to te pre-setup hooks in .ddev/aljibe.yml file.
To launch local, or env tests, you can run:
ddev behat [local|pro|other_behat_folder] [suite]
By default there is one theme defined in .ddev/aljibe.yml. You can add multiple themes. To process them, run:
ddev frontend production [theme_name]
where theme_name is the key defined in .ddev/aljibe.yml. You can run a watch command to process the CSS on the fly:
ddev frontend watch [theme_name]
If you use ddev-solr addon and need to sync the solr config from the server, you can run:
ddev solr-sync
It is needed to install mkcert and libnss3-tools, and then run:
mkcert -install
Until apache/netbeans#7562 is solved you need to create a file named xdebug.ini at .ddev/php with the following content:
[XDebug]
xdebug.idekey = netbeans-xdebug
NOTE: The netbeans-xdebug is the default Session ID value in the the Debugging tab in the PHP Netbeans' configuration dialog. If you have changed it do it in the xdebug.ini file as well.
Follow the instructions from ddev xprofiler documentation
[XDebug]
xdebug.mode=profile
xdebug.start_with_request=yes
# Set a ddev shared folder for the xprofile reports.
xdebug.output_dir=/var/www/html/tmp/xprofile
xdebug.profiler_output_name=trace.%c%p%r%u.out
Review the php info (/admin/reports/status/php) page to review that the xdebug variables are setup properly after run ddev xdebug on, restart the project if necessary.