Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shaal/DrupalPod
Start Drupal contributions with 1 click.
https://github.com/shaal/DrupalPod
contributions ddev drupal drupalpod dx gitpod hacktoberfest
Last synced: about 1 month ago
JSON representation
Start Drupal contributions with 1 click.
- Host: GitHub
- URL: https://github.com/shaal/DrupalPod
- Owner: shaal
- License: mit
- Created: 2021-05-06T13:38:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T17:42:28.000Z (5 months ago)
- Last Synced: 2024-05-22T21:32:12.592Z (4 months ago)
- Topics: contributions, ddev, drupal, drupalpod, dx, gitpod, hacktoberfest
- Language: Shell
- Homepage: https://shaal.github.io/DrupalPod
- Size: 540 KB
- Stars: 159
- Watchers: 8
- Forks: 52
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-ddev - DrupalPod - Start Drupal contributions with 1 click. (Cloud-based Solutions)
README
# DrupalPod
|
:point_right: Start here
1. Download the DrupalPod browser extension
[Chrome](https://chrome.google.com/webstore/detail/drupalpod-helper-extensio/pjfjhkcfkhbemnbpkakjhmboacefmjjl?hl=en) or [Firefox](https://addons.mozilla.org/en-US/firefox/addon/drupalpod).
2. Go to any issue page on Drupal.org
(core, module, or theme).
3. Click on the DrupalPod extension.
4. (Optional) Choose a patch / issue fork / branch.
:tada: A full Drupal development environment is being generated for you :tada:
Please submit [feedback, bug reports and feature requests](https://github.com/shaal/DrupalPod/issues/new/choose) | [](https://gitpod.io/from-referrer/) |
| - | :- |
## About the project
This project allows you to work on Drupal contributions with a familiar setup of a "normal" Drupal website.\
No computer is needed because it is all running in the cloud.
* Install additional packages - `ddev composer`
* Run Drush commands - `ddev drush `
* Run tests
* Nightwatch - `ddev nightwatch `
* PHPUnit - `ddev phpunit `
* IDE in a browser
* VScode (default)
* PHPStorm - run `phpstorm`
## Project structure
* Every project is cloned into `/repos/`
* Required by composer
* Symlinked into a normal Drupal website structure:
* Core directory `/web/core`
* Module directory `/web/modules/contrib/module_name`
* Theme directory `/web/themes/contrib/theme_name`
## The secret sauce
* [Gitpod](https://www.gitpod.io) - development environment in the cloud
* [DDEV](https://ddev.readthedocs.io/en/stable) - easy setup for PHP projects using Docker
* [DrupalPod](https://chrome.google.com/webstore/detail/drupalpod-helper-extensio/pjfjhkcfkhbemnbpkakjhmboacefmjjl?hl=en
) Browser Extension
* [Drupal Core Development Project](https://github.com/joachim-n/drupal-core-development-project)
## Pushing code
_\* In order to push code, a **one time** SSH keys setup is required._
From within a Gitpod workspace run:
1. `.gitpod/drupal/ssh/02-setup-private-ssh.sh` \
Follow the instructions on the screen.
1. `.gitpod/drupal/ssh/04-confirm-ssh-setup.sh` \
If SSH keys are valid, it stores your private SSH key as an environment variable in Gitpod.
## Notes
* Manual SSH setup is a temporary requirement until the Drupal's self-hosted Gitlab gets integrated with Gitpod.
[WIP - making a friendlier interactive dialog](https://github.com/shaal/DrupalPod/issues/4).
* If you prefer working locally - you can clone this repo to your computer.\
The only 2 requirements are [Docker](https://ddev.readthedocs.io/en/stable/users/docker_installation/) and [DDEV](https://ddev.readthedocs.io/en/stable/#installation).
## Thank you
* [Randy Fay](https://github.com/rfay)
* [Joe Still](https://github.com/bioshazard)
* [Joachim](https://github.com/joachim-n)
---
