MohsinQK / TYPO3-gitpod

Gitpod for TYPO3

TYPO3 + Gitpod

Set up a full TYPO3 dev environment in a browser

Prerequisites

1. Sign up for gitpod.io

Try it out

1. Click on the following link https://gitpod.io/#https://github.com/Starraider/TYPO3-gitpod
2. Your environment is being prepared, wait about 40 seconds (A splash screen will appear)
3. VScode (or Theia depending on your settings) IDE will be displayed.
4. Note that one terminal is running sudo docker-up, and another terminal in parallel is running ddev start
5. Find your website's URL gp url 8080
6. Open your website's URL in a browser, you should see TYPO3's installation screen.
7. 🎉

How does it work?

1. Gitpod - development environment based on Docker
   1. .gitpod.yml
      1. Defines the main docker image this environment is built on - .gitpod.Dockerfile
      2. Run initial commands using 3 terminals in parallel:
         1. gitpod-setup-ddev.sh
         2. composer install
         3. sudo docker-up
   2. .gitpod.Dockerfile
      1. Set base image to Gitpod's workspace-full (link)
      2. Install ddev using brew
2. ddev - ridiculously simple setup for complex development environments
   1. .ddev/config.yaml - main ddev (default) configuration, can be generated by running ddev config
   2. .ddev/gitpod-setup-ddev.sh - generate config overrides for ddev to work in the Gitpod environment.
      1. Delete any existing Docker images and containers (due to Gitpod bug, that cause issues when restarting a workspace)
      2. Set certain ports to public, following Gitpod's syntax [port]-[workspace-url]
         1. 8080 - TYPO3 Website
         2. 8025 - Mailhog
         3. 8036 - PHPmyadmin
      3. Set host.docker.internal with the correct value of gitpod's host ip
      4. Starts ddev

Thank you

This project was inspired by shaal/ddev-gitpod