Quickstart guide: Install Spryker on MacOS and Linux

Last updated:
Edit on GitHub

This document describes how to quickly install Spryker on MacOS or Linux in Development mode. If you are installing Spryker for the first time or need detailed instructions, we recommend starting with Install Spryker.

To install Spryker on macOS or Linux, follow these steps:

Prerequisites

  • Install Docker or OrbStack(macOS only).

  • macOS: Install or update Mutagen and Mutagen Compose:

brew list | grep mutagen | xargs brew remove && brew install mutagen-io/mutagen/mutagen mutagen-io/mutagen/mutagen-compose && mutagen daemon stop && mutagen daemon start

1. Clone the Demo Shop of your choice

  • B2B Demo Shop:
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202404.0 --single-branch ./b2b-demo-shop && \
cd b2b-demo-shop && \
git clone https://github.com/spryker/docker-sdk.git --single-branch docker && \
docker/sdk bootstrap deploy.dev.yml
  • B2C Demo Shop:
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202404.0 --single-branch ./b2c-demo-shop && \
cd b2c-demo-shop && \
git clone https://github.com/spryker/docker-sdk.git --single-branch docker && \
docker/sdk bootstrap deploy.dev.yml
  • B2B Marketplace Demo Shop:
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202404.0 --single-branch ./b2b-demo-marketplace && \
cd b2b-demo-marketplace && \
git clone https://github.com/spryker/docker-sdk.git --single-branch docker && \
docker/sdk bootstrap deploy.dev.yml
  • B2C Marketplace Demo Shop:
git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202404.0 --single-branch ./b2c-demo-marketplace && \
cd b2c-demo-marketplace && \
git clone https://github.com/spryker/docker-sdk.git --single-branch docker && \
docker/sdk bootstrap deploy.dev.yml

2. Update the hosts

Update the hosts file using the command provided in the output of the previous step. It should be similar to the following:

update-hosts

3. Build and start the instance

docker/sdk up

The project is now running. For the full list of the project’s endpoints, see http://spryker.local.

For detailed installation instructions, start with Install Spryker.