Set up the Merchant Portal

Edit on GitHub

This document provides details about how to set up the Spryker Merchant Portal.


To start using Merchant Portal, install Spryker demo-shop:

  1. Use this repository for the Marketplace project installation.
  2. Install the project using one of the following guides:


To build Merchant Portal, install or update the following tools:

  • Node.js—minimum version is v12.
  • Yarn - minimum version is 2.0.0 and maximum is 2.3.x.


The main environmental differences between the existing frontends (Yves, Zed) and Merchant Portal are:

  • Minimum Node.js version is v12.
  • npm is replaced by Yarn v2 with Workspaces.

Using a “unified” approach, all frontend dependencies must be installed in one step

  • The entire project is now a “Yarn Workspace,” meaning each submodule declares its dependencies. During the installation stage, Yarn installs all of those dependencies and hoists them up into the root of the project.

Install dependencies and build Merchant Portal

yarn install
yarn mp:build

All possible commands are listed in the package.json file in the root folder.

Once everything has been installed, you can access the UI of Merchant Portal by going to $[local_domain]/security-merchant-portal-gui/login.

All Merchant Portal modules are located in the /vendor/spryker/spryker directory.