Install in Development mode on Windows

Last updated:
Edit on GitHub

This document describes how to install Spryker in Development Mode on Windows.

Install the prerequisites on Windows

Clone a Demo Shop and the Docker SDK

Filesystems

Avoid using folders under the Windows filesystem, because they have to be synced with the Ubuntu filesystem, which slows down all operations significantly.

Not recommended: /mnt/c/Users/jdoe/Desktop/project.

Recommended: /home/jdoe/workspace/project.

  1. Open Ubuntu.

  2. Open a terminal.

  3. Create a new folder and navigate into it.

  4. Clone one of the Demo Shops:

    • B2C Demo Shop:
    git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202311.0 --single-branch ./b2c-demo-shop && \
cd b2c-demo-shop
    • B2B Demo Shop:
    git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202311.0 --single-branch ./b2b-demo-shop && \
cd b2c-demo-shop
    • B2C Marketplace Demo Shop
    git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202311.0 --single-branch ./b2c-demo-marketplace && \
cd b2c-demo-marketplace
    • B2B Marketplace Demo Shop
    git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202311.0 --single-branch ./b2b-demo-marketplace && \
cd b2b-demo-marketplace
Verification

Make sure that you are in the Demo Shop’s folder by running the pwd command.

  1. Clone the Docker SDK:
git clone https://github.com/spryker/docker-sdk.git --single-branch docker

Configure and start the instance

  1. In {shop_name}/docker/context/php/debug/etc/php/debug.conf.d/69-xdebug.ini, set xdebug.remote_host and xdebug.client_host to host.docker.internal:
...
xdebug.remote_host=host.docker.internal
...
xdebug.client_host=host.docker.internal
  1. Add your user to the docker group:
sudo usermod -aG docker $USER
  1. Bootstrap local docker setup:
docker/sdk bootstrap deploy.dev.yml
Bootstrap

Once you finish the setup, you don’t need to run bootstrap to start the instance. You only need to run it after updating the Docker SDK or changing the deploy file.

  1. Update the hosts file based on the output of the previous step:

    1. Open the Start menu.
    2. In the search field, enter Notepad.
    3. Right-click Notepad and select Run as administrator.
    4. In the User Account Control window, select Yes to confirm the action.
    5. In the upper navigation panel, click File > Open.
    6. Put the following path into the address line: C:\Windows\System32\drivers\etc.
    7. In the File name line, enter hosts and select Open. The hosts file opens in the drop-down.
    8. Add the entries provided in the outpout of the bootstrap command.
    Warning

    It is not recommended to exceed 10 hostnames per line on Windows. Split a long line into multiple lines if necessary.

    1. Click File > Save.
    2. Close the file.

  2. Build and start the instance:

docker/sdk up

Depending on the hardware performance, the first project launch can take up to 20 minutes.

Endpoints

To ensure that the installation is successful, make sure you can access the configured endpoints from the Deploy file. For more information about the Deploy file, see Deploy file reference.

RabbitMQ UI credentials

To access RabbitMQ UI, use spryker as a username and secret as a password. You can adjust the credentials in deploy.yml.

Get the list of useful commands

To get the full and up-to-date list of commands, run docker/sdk help.

Next steps