Pre-requisites
To create a component for use with the Squiz DXP the following pre-requisites apply.
Knowledge pre-requisites
Knowledge and understanding of the following are presumed:
-
JSON Schema; and
Tool pre-requisites
The following software and tools are required on the local development system:
-
A command shell.
This tutorial assumes the zsh command shell but the bash shell or the PowerShell should also work.
-
Node 20 or higher.
To check that Node 20 or higher is installed run the following command in the command shell:
node -vIf Node 20 or higher is installed the command will return a version number something like as follows:
v20.18.0 -
The Node Package Manager (NPM).
To check that NPM is installed run the following command in the command shell:
npm -vIf NPM is installed the command will return a version number something like as follows:
10.8.2 -
The DXP CLI tool.
This is installed in the next step.
-
A JSON- and JavaScript-friendly text editor or IDE.
JSON- and JavaScript-friendly text editors include (but are not limited to):
Environment pre-requisites
The deployment environment pre-requisites are as follows:
-
A Matrix Content Management System either on SaaS, or newer than version 6.35.0 with the Component Service features enabled.
-
Developer-level access to the Squiz DXP.
-
The Component Service enabled.
The DXP CLI tool is required to confirm the Component Service is enabled.
See Install the DXP CLI tool for the procedure to check this.
If you do not have the Component Service available in the DXP, contact Customer Success.
Next Step: Install the DXP CLI.