Installing in Demo mode on MacOS and Linux

Last updated:
Edit on GitHub
Info

Starting with the 202204.0 release, the following guide applies to both Intel and ARM architectures. You can install the demo shops of previous versions on ARM chips by following the steps from the Switch to ARM architecture technical enhancement guide.

This document describes the procedure of installing Spryker in Demo Mode on MacOS and Linux.

Install Docker prerequisites on MacOS and Linux

To install Docker prerequisites, follow one of the guides:

Clone a Demo Shop and the Docker SDK

  1. Open a terminal.

  2. Create a new folder and navigate into it.

  3. Depending on the desired Demo Shop:

    • Clone the B2C repository:
    git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202204.0-p2 --single-branch ./b2c-demo-shop
    • Clone the B2B repository:
    git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202204.0-p2 --single-branch ./b2b-demo-shop

  4. 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

Configure and start the instance

  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:
echo "127.0.0.1 zed.de.spryker.local yves.de.spryker.local glue.de.spryker.local zed.at.spryker.local yves.at.spryker.local glue.at.spryker.local zed.us.spryker.local yves.us.spryker.local glue.us.spryker.local mail.spryker.local scheduler.spryker.local queue.spryker.local backoffice.de.spryker.local" | sudo tee -a /etc/hosts

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

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 backoffice.de.spryker.local, backoffice.at.spryker.local, backoffice.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