Install in Development 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 Switch to ARM architecture.

This document describes how to install Spryker in Development Mode on MacOS and Linux.

Install Docker prerequisites on MacOS and Linux

Clone a Demo Shop and the Docker SDK

  1. Open a terminal.

  2. Clone one of the following Demo Shops and navigate into its folder:

    • 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 b2b-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

  3. Clone the Docker SDK:

git clone https://github.com/spryker/docker-sdk.git --single-branch docker

Configure and start the instance

  1. Bootstrap the 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 using the command provided in the output of the previous step. It should be similar to the following:

update-hosts

  1. 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 endpoints configured in the deploy file. For more information about the deploy file, see Deploy file reference.

Back-Office

The default credentials to access the back-office are located inside this file /src/Pyz/Zed/User/UserConfig.php

RabbitMQ

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 to learn about the Deploy file.

Get the list of useful commands

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

Next steps