shopware-devenv

A little wrapper around the Shopware devenv environment that gets out of your way.

This will help you to daemonize devenv and allow you to run certain commands from anywhere in the project.

Features

• Daemonize devenv up - no need for keep this in foreground
• devenv.local.nix for a better DX (e.g. All tools on one domain & full https)
• Update your devenv.local.nix trough swde config
• Execute commands everywhere inside the project
  • e.g. bin/console
  • e.g. composer, limited to the wrappers like build and watch
• Shell completions
• Symfony dump server support
• Easily install plugins
• Storefront proxy patch for https

How to install

Archlinux

1. mkdir /tmp/swde; cd /tmp/swde
2. wget https://raw.githubusercontent.com/cyl3x/shopware-devenv/master/PKGBUILD
3. makepkg -si
4. sudo tee -a /etc/hosts <<<"127.0.0.1 dev.localhost"

Generic

1. Setup devenv with direnv (Shopware docs)
2. Download the pre-compiled binary and put it in:
   • Linux: ~/.local/bin or /usr/local/bin
   • MacOs: /usr/local/bin
   • Windows: Currently unsupported
3. sudo tee -a /etc/hosts <<<"127.0.0.1 dev.localhost"

Do not forget to run swde config inside your platform project directory

How to use

Wrapper for the Shopware devenv development environment

Usage: swde [OPTIONS] <COMMAND>

Commands:
  comp         Generate a SHELL completion script and print to stdout
  config       Update to the included devenv.local.nix
  up           Start devenv in background
  down         Stop devenv in background
  log          Show devenv logs
  build        Build storefront/admin/platform
  watch        Watch storefront/admin/unit/jest
  console      bin/console from platform
  plugin       Install/Activate/Uninstall/Reinstall plugins
  update       Update platform and garbage collect devenv
  dump-server  Start the symfony dump server
  help         Print this message or the help of the given subcommand(s)

Options:
  -v, --verbose  Set the verbosity. Can also be set with SWDE_VERBOSE=1
  -h, --help     Print help
  -V, --version  Print version

Storefront proxy

The current configuration of devenv.local.nix favours https over http.
Since the storefront proxy can't proxy https and has no override capabilities, a workaround is needed.

To do this, you have to override the APP_URL before starting the watcher:

# APP_URL_HTTP contains the http url
APP_URL=$APP_URL_HTTP composer watch:storefront

And add a new domain with the output of printenv APP_URL_HTTP to your saleschannel. Access the https watcher over https://store.dev.localhost:2000.

devenv.local.nix

By simply executing swde config a devenv.local.nix will be dumped (Your old one will be backed up).

The config will help you to manage multiple concurrent devenv setups.

Available services

• https://dev.localhost:2000 - Base shopware
• https://admin.dev.localhost:2000 - Administration watcher
• https://store.dev.localhost:2000 - Storefront watcher
• https://mail.dev.localhost:2000 - Mailhog/Mailpit for mails
• https://adminer.dev.localhost:2000 - Adminer for database

Multiple instances use the same URL schema, but their port is incremented by a thousand.