https://github.com/shaal/ddev-gitpod

A full Drupal dev environment in a browser
https://github.com/shaal/ddev-gitpod

browser ddev docker drupal gitpod vscode xdebug

Last synced: 3 days ago
JSON representation

A full Drupal dev environment in a browser

• Host: GitHub
• URL: https://github.com/shaal/ddev-gitpod
• Owner: shaal
• License: mit
• Created: 2020-10-27T13:40:50.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-08T22:15:17.000Z (6 months ago)
• Last Synced: 2025-01-22T18:03:23.336Z (10 days ago)
• Topics: browser, ddev, docker, drupal, gitpod, vscode, xdebug
• Language: PHP
• Homepage:
• Size: 372 KB
• Stars: 113
• Watchers: 8
• Forks: 115
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/shaal/ddev-gitpod)

# ddev + Gitpod

## Set up a full Drupal dev environment in a browser

This project demonstrates a complete Drupal 9 development environment, utilizing ddev and Gitpod, through your browser.

## Video Demo

Watch a 5 minutes walkthrough video:



## Prerequisites:

1. [Sign up for gitpod.io](https://gitpod.io/login)

## Try it out:

1. Click on the following link

  https://gitpod.io/#https://github.com/shaal/ddev-gitpod

1. Your environment is being prepared, wait about 40 seconds (A splash screen will appear)

1. VScode IDE will be displayed, a few seconds later you will see Umami demo.

1. Run in terminal `ddev xdebug on`

1. Open VScode's debugger, place a new breakpoint in `web/index.php`

1. Open your website's URL in a browser.

1. :tada:

## Do you like PhpStorm instead of Theia or VScode?

1. Open a bash window at the bottom

2. `.ddev/run-phpstorm.sh`

## How does it work?

1. Gitpod - development environment based on Docker

    1. [.gitpod.yml](https://github.com/shaal/ddev-gitpod/blob/main/.gitpod.yml)

        1. Defines the main docker image this environment is built on - `.gitpod.Dockerfile`

        1. Run prebuild commands:

            1. Start ddev

            1. Run `composer install`

            1. Install Umami demo website

    1. [.gitpod.Dockerfile](https://github.com/shaal/ddev-gitpod/blob/main/.gitpod.Dockerfile)

        1. Set base image to Gitpod's `workspace-full` ([link](https://github.com/gitpod-io/workspace-images/tree/master/full))

        1. Install ddev using brew

1. ddev - ridiculously simple setup for complex development environments, allows developers working locally or working with Gitpod in the cloud.

    1. [.ddev/config.yaml](https://github.com/shaal/ddev-gitpod/blob/main/.ddev/config.yaml) - main ddev (default) configuration, can be generated by running `ddev config`

## Thank you

[@rfay](https://github.com/rfay) for your endless patience and relentless support that made this project possible.

### Persistent Storage:

* Gitpod backs up the state of the `/workspace/` folder between workspace starts, so that you can revisit them later. Attention: Files in other locations will not be saved!

* [Additional Storage Solutions](https://www.gitpod.io/docs/self-hosted/latest/install/storage)