-
-
Notifications
You must be signed in to change notification settings - Fork 450
docs: added ddev snippets #2575
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# OpenMage DDEV environment | ||
|
||
__This is work-in-progress.__ | ||
|
||
## Enable developer mode | ||
|
||
Set environment variables here: | ||
|
||
`.ddev/config.yaml` | ||
|
||
``` | ||
web_environment: [ | ||
MAGE_IS_DEVELOPER_MODE=1 | ||
] | ||
``` | ||
|
||
## Use xDebug with PhpStorm | ||
|
||
If xdebug works not correctly with phpstorm. | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If xDebug doesn't work properly in PhpStorm. |
||
`.ddev/php/xdebug.ini` | ||
|
||
``` | ||
[xdebug] | ||
xdebug.mode=debug | ||
xdebug.start_with_request=trigger | ||
``` | ||
|
||
## Access DB in PhpStorm | ||
|
||
DDEV changes port numbers on every restart. | ||
|
||
If you use PhpStorms DB feature, it is helpful to use fixed port numbers. E.g. | ||
|
||
`.ddev/config.yaml` | ||
|
||
``` | ||
host_db_port: 6000 | ||
``` | ||
|
||
## Setup cronjob | ||
|
||
Run `ddev get drud/ddev-cron` first! | ||
|
||
`.ddev/config.cron.yaml` | ||
|
||
``` | ||
hooks: | ||
post-start: | ||
- exec: printf "SHELL=/bin/bash\n* * * * * /var/www/html/cron.sh\n" | crontab | ||
|
||
``` | ||
|
||
## Install compass | ||
|
||
[Compass](http://compass-style.org/) is required for editing scss-files from RWD-theme. | ||
|
||
`.ddev/web-build/Dockerfile.ddev-compass` | ||
|
||
``` | ||
ARG BASE_IMAGE | ||
FROM $BASE_IMAGE | ||
RUN apt-get update | ||
RUN DEBIAN_FRONTEND=noninteractive apt-get install -y -o Dpkg::Options::="--force-confold" --no-install-recommends --no-install-suggests build-essential ruby-full rubygems | ||
RUN gem install compass | ||
``` | ||
|
||
https://stackoverflow.com/questions/61787926/how-can-i-get-sass-compass-into-the-ddev-web-container | ||
|
||
## Example command shortcut | ||
|
||
`.ddev/commands/web/phpstan` | ||
|
||
``` | ||
#!/bin/bash | ||
|
||
## Description: run PHPStan | ||
## Usage: phpstan | ||
## Example: ddev phpstan <path-to-files> | ||
|
||
php vendor/bin/phpstan analyze -c .github/phpstan.neon "$@" | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would put this link on the next line
https://ddev.readthedocs.io/en/stable/