Install in Development mode on WindowsEdit 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
Avoid using folders under the Windows filesystem, because they have to be synced with the Ubuntu filesystem, which slows down all operations significantly.
Open a terminal.
Create a new folder and navigate into it.
Clone one of the Demo Shops:
- B2C Demo Shop:
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202307.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 202307.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 202307.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 202307.0 --single-branch ./b2b-demo-marketplace && \ cd b2b-demo-marketplace
Make sure that you are in the Demo Shop’s folder by running the
- Clone the Docker SDK:
git clone https://github.com/spryker/docker-sdk.git --single-branch docker
Configure and start the instance
... xdebug.remote_host=host.docker.internal ... xdebug.client_host=host.docker.internal
- Add your user to the
sudo usermod -aG docker $USER
- Bootstrap local docker setup:
docker/sdk bootstrap deploy.dev.yml
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.
Update the hosts file based on the output of the previous step:
- Open the Start menu.
- In the search field, enter
- Right-click Notepad and select Run as administrator.
- In the User Account Control window, select Yes to confirm the action.
- In the upper navigation panel, click File > Open.
- Put the following path into the address line:
- In the File name line, enter
hostsand select Open. The hosts file opens in the drop-down.
- Add the entries provided in the outpout of the
It is not recommended to exceed 10 hostnames per line on Windows. Split a long line into multiple lines if necessary.
- Click File > Save.
- Close the file.
Build and start the instance:
Depending on the hardware performance, the first project launch can take up to 20 minutes.
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 - 1.0.
To access RabbitMQ UI, use
spryker as a username and
secret as a password. You can adjust the credentials in
Get the list of useful commands
To get the full and up-to-date list of commands, run
For submitting the form