Installing in Demo mode on Windows

Edit on GitHub

This document describes the procedure of installing Spryker in Demo Mode on Windows.

Installing Docker prerequisites on Windows

To install Docker prerequisites on Windows with WSL1, follow Installing Docker prerequisites on Windows with WSL1.

To install Docker prerequisites on Windows with WSL2, follow Installing Docker prerequisites on Windows with WSL2.

Installing Spryker in Demo mode on Windows

Follow the steps to install Spryker in Demo Mode:

  1. Open Ubuntu.

  2. Open a terminal.

  3. Create a new folder and navigate into it.

  4. Depending on the desired Demo Shop:

    • Clone the B2C repository:
    git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202108.0  --single-branch ./b2c-demo-shop
    
    • Clone the B2B repository:
    git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202108.0  --single-branch ./b2b-demo-shop
    
  5. Depending on the cloned repository, navigate into the cloned folder:

    • B2C repository:
    cd b2c-demo-shop
    
    • B2B repository:
    cd b2b-demo-shop
    
Verification

Make sure that you are in the correct folder by running the pwd command.

  1. Clone the Docker SDK repository into the same folder:
git clone https://github.com/spryker/docker-sdk.git --single-branch docker
  1. Add your user to the docker group:
sudo usermod -aG docker $USER
  1. Bootstrap the local Docker setup for demo:
docker/sdk bootstrap
Bootstrap

Once you finish the setup, you don’t need to run bootstrap to start the instance. You only need to run it after:

  • Docker SDK version update;
  • Deploy file update.
  1. Once the job finishes, build and start the instance:
docker/sdk up
  1. Update the hosts file:

    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, select 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 following line into the file:
    127.0.0.1   zed.de.spryker.local glue.de.spryker.local yves.de.spryker.local scheduler.spryker.local mail.spryker.local queue.spryker.local
    

    If needed, add corresponding entries for other stores. For example, if you are going to have a US store, add the following entries: zed.us.spryker.local glue.us.spryker.local yves.us.spryker.local

    1. Select File > Save.
    2. Close the file.
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 following endpoints.

Application Endpoints
The Storefront yves.de.spryker.local, yves.at.spryker.local, yves.us.spryker.local
the Back Office zed.de.spryker.local, zed.at.spryker.local, zed.us.spryker.local
Glue API glue.de.spryker.local, glue.at.spryker.local, glue.us.spryker.local
Jenkins (scheduler) scheduler.spryker.local
RabbitMQ UI (queue manager) queue.spryker.local
Mailhog UI (email catcher) mail.spryker.local
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. See Deploy file reference - 1.0 to learn about the Deploy file.

Getting the list of useful commands

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

Next steps