kraal-spryker / b2c-demo-shop

Spryker B2C Demo Shop based on the Spryker Commerce OS

Spryker B2C Demo Shop

Description

Spryker B2C Demo Shop is a collection of Spryker B2C-specific features. It suits most projects as a starting point of development and can be used to explore Spryker.

B2C Demo Shop quick start

This section describes how to get started with the B2C Demo Shop quickly.

For detailed installation instructions, see Installing Spryker with Docker or Installing with Development Virtual Machine.

Prerequisites

For full installation prerequisites, see one of the following:

• Installing Docker prerequisites on MacOS
• Installing Docker prerequisites on Linux
• Installing Docker prerequisites on Windows

Recommended system requirements for MacOS:

Macbook type	vCPU	RAM
15'	4	6GB
13'	2	4GB

Installing the B2C Demo Shop

To install the B2C Demo Shop:

1. Create a project folder and clone the B2C Demo Shop and the Docker SDK:

mkdir spryker-b2c && cd spryker-b2c
git clone https://github.com/spryker-shop/b2c-demo-shop.git ./
git clone [email protected]:spryker/docker-sdk.git docker

2. Set up a desired environment:

• Setting up a development environment
• Setting up a production-like environment

Setting up a development environment

To set up a development environment:

1. Bootstrap the docker setup:

docker/sdk boot deploy.dev.yml

2. If the command you've run in the previous step returned instructions, follow them.

3. Build and start the instance:

docker/sdk up

4. Switch to your branch, re-build the application with assets and demo data from the new branch:

git checkout {your_branch}
docker/sdk boot -s deploy.dev.yml
docker/sdk up --build --assets --data

Depending on your requirements, you can select any combination of the following up command attributes. To fetch all the changes from the branch you switch to, we recommend running the command with all of them:

• --build - update composer, generate transfer objects, etc.
• --assets - build assets
• --data - get new demo data

You've set up your Spryker B2C Demo Shop and can access your applications.

Setting up a production-like environment

To set up a production-like environment:

1. Bootstrap the docker setup:

docker/sdk boot -s

2. If the command you've run in the previous step returned instructions, follow them.

3. Build and start the instance:

docker/sdk up

4. Switch to your branch in one of the following ways:

• Switch to your brunch, re-build the application with assets and demo data from the new branch:

git checkout {your_branch}
docker/sdk boot -s
docker/sdk up --assets --data

• Light git checkout:

git checkout {your_branch}
docker/sdk boot -s

docker/sdk up

Depending on your requirements, you can select any combination of the following up command attributes. To fetch all the changes from the branch you switch to, we recommend running the command with all of them:

• --build - update composer, generate transfer objects, etc.
• --assets - build assets
• --data - get new demo data

5. Reload all the data:

docker/sdk clean-data && docker/sdk up && docker/sdk console q:w:s -v -s

You've set up your Spryker B2C Demo Shop and can access your applications.

Troubleshooting installation of the B2C Demo Shop

This section describes the most common issues related to the installation of the B2C Demo Shop.

For a complete troubleshooting, see Troubleshooting Spryker in Docker issues.

when

You get unexpected application behavior or errors.

then

1. Check the state of the directory:

git status

2. If there are untracked files (returned in red), and they are not necessary, remove them.

3. Restart file synchronization and rebuild the codebase:

docker/sdk trouble
docker/sdk boot -s deploy.dev.yml
docker/sdk up --build --assets

when You do not see the expected demo data on the Storefront.

then

1. Open the queue broker and wait until all the queues are empty.

2. If the queues are empty, and the issue persists, reload the demo data:

docker/sdk trouble
docker/sdk boot -s deploy.dev.yml
docker/sdk up --build --assets --data

Installation of B2C Demo Shop with Docker

For detailed installation instructions of Spryker with Docker, see Installing Spryker with Docker.

Glue API reference

See Glue API reference at REST API reference.

Contributing to the repository

For contribution guidelines, see Code contribution guide.