Quick installation guide: Mac OS and Linux

Last updated:
Edit on GitHub

To install Spryker on Mac OS or Linux, follow these steps:

1. Clone the Demo Shop of your choice

  • B2B Demo Shop:
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202204.0-p1 --single-branch ./b2b-demo-shop
  • B2C Demo Shop:
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202204.0-p1 --single-branch ./b2c-demo-shop
  • B2B Marketplace Demo Shop:
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202204.0-p1 --single-branch ./b2b-demo-marketplace
  • B2C Marketplace Demo Shop:
git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202204.0-p1 --single-branch ./b2c-demo-marketplace

2. Go to the newly created folder

cd <new-folder-name>

3. Clone the Docker SDK repository into the same folder

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

4. Bootstrap the local Docker environment

  1. Run the following command:
docker/sdk bootstrap deploy.dev.yml
Info

If you do not need to build Spryker with development tools and file synchronization, run the following command:

docker/sdk bootstrap

This mode is better suited to showcase Spryker features.

  1. Update the host file /etc/hosts with the command that the docker/sdk bootstrap command displays.

5. Build and start your local instance

docker/sdk up

6. Open your new Spryker project in the browser

  • Storefront: yves.de.spryker.local
  • Back Office: backoffice.de.spryker.local
  • Frontend API: glue-storefront.de.spryker.local and its schema swagger.spryker.local
Info

If you see .de. in your URL, it means that this application is store-specific. By default, Spryker comes with three stores: de, at, and us.

If you need more details about the installation, see the detailed installation guides: