davefletcher/drupal-ide repository overview

⁠Drupal IDE

Full featured IDE for Drupal based on VSCode and Docker Desktop. Drupal and Apache run in it's own container. MySQL runs in a separate container. Project management tools, text editor, debugger, shell, version control all in one integrated environment.

⁠:warning: Do not clone this repository. Add it as a submodule. See Installation⁠ below.

⁠Contents

1. Requirements⁠
2. Installation⁠
3. Launch⁠
4. Tools⁠

⁠Requirements

:ballot_box_with_check: Install Docker Desktop⁠. Note that Docker Desktop is not supported in all versions of Windows unfortunately.

:ballot_box_with_check: Install VSCode⁠.

:ballot_box_with_check: From the VSCode extension manager, install the Remote Containers⁠ extension.

:ballot_box_with_check: Additionally, you may need to configure the disk your project directory lives on as a Docker Desktop shared drive. If some shell (eg PowerShell) code appears when you enable a share, it is important to run that code in a terminal.

:warning: This software is brand new and is currently only tested in Windows 10 Pro. It should run on MacOS but this is untested. Feedback welcome via issue queue or pull request. More complete documentation still under construction.

⁠Installation

In your project directory, run the following command:

    $ git submodule add https://github.com/dfletcher/drupal-ide .devcontainer

This will add a .devcontainer subdirectory which VSCode will recognize.

Note that you do not need an existing Drupal installation to test the IDE or start a new project. Use the following commands to start an empty Drupal IDE project:

    $ mkdir newproject
    $ cd newproject
    $ git init
    $ mkdir -p web/modules web/themes web/features
    $ git submodule add https://github.com/dfletcher/drupal-ide .devcontainer

Before you open the project in a remote container, configure by copying some files from .devcontainer into your project root.

    $ cp .devcontainer/.env.drupal-ide.example .env.drupal-ide
    $ cp -r .devcontainer/.vscode .vscode

Open .env.drupal-ide locally and configure your site name and any modules that you want enabled at install time.

The .vscode subdirectory contains X-Debug configuration for debugging. You may have to adjust the paths.

⁠Launch

In VSCode, open the project folder that contains .devcontainer. VSCode should prompt you to reopen as a remote container.

If your project contains a composer.json, it will be symlinked to the project root at /var/www/html and your deps should be loaded at container build time.

⁠Tools

The following tools are installed:

• /usr/local/bin/drupaldb Connects to mysql with database selected.
• /usr/local/bin/drupaldbdump Dump the entire database.

These can be used from terminal inside VSCode or from outside the container using the docker run command.

Example:

    $ docker ps
    2195d98e9f46        davefletcher/drupal-ide 
    $ ssh user@myserver mysqldump -udbuser -pdbpass database | docker exec 2195d98e9f46 drupaldb

This command would dump the database at myserver into the Drupal IDE database. Of course, this is a partial example, to do a complete import you would need to drop the drupal database and re-create it e.g. DROP DATABASE drupal; CREATE DATABASE drupal.

Note that you can also interact with the mysql container directly.