This document describes the procedure of installing Spryker in Demo Mode on MacOS and Linux.
To install Docker prerequisites, follow one of the guides:
Follow the steps to install Spryker in Demo Mode:
-
Open a terminal.
-
Create a new folder and navigate into it.
-
Depending on the desired Demo Shop:
a. Clone the B2C repository:
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202009.0-p1 --single-branch ./b2c-demo-shop
b. Clone the B2B repository:
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202009.0-p1 --single-branch ./b2b-demo-shop
-
Depending on the cloned repository, navigate into the cloned folder:
- B2C repository:
cd b2c-demo-shop
- B2B repository:
cd b2b-demo-shop
:::(Warning) (Verification)
Make sure that you are in the correct folder by running the pwd
command.
:::
- Clone the Docker SDK repository into the same folder:
git clone [email protected]:spryker/docker-sdk.git --single-branch docker
:::(Warning) (Verification)
Make sure docker 18.09.1+
and docker compose 2+
are installed:
$ docker version
$ docker compose version
:::
- Bootstrap the local Docker setup for demo:
docker/sdk bootstrap
:::(Warning) (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. :::
-
Update the
hosts
file: Follow the installation instructions in the white box from thedocker/sdk bootstrap
command execution results to prepare the environment. :::(Info) () You can rundocker/sdk install
afterbootstrap
to get the list of the instructions. ::: -
Once the job finishes, build and start the instance:
docker/sdk up
:::(Warning) () Depending on the hardware performance, the first project launch can take up to 20 minutes. :::
To ensure that the installation is successful, make sure you can access the configured endpoints from the Deploy file. See Deploy file reference - 1.0 to learn about the Deploy file.
:::(Info) (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
.
:::
To get the full and up-to-date list of commands, run docker/sdk help
.