Help Center

Menu

Getting started

Prerequisites

To successfully use Component Service, you will need knowledge and understanding of the following:

You will also need the following software and tools:

  • A Matrix system either on SaaS, or newer than 6.32.1 with the Component Service features enabled.

  • A command line environment.

  • A Git connection.

  • Node 16 or higher and NPM.

  • A text editor or IDE that can handle JSON and JavaScript. For example, Visual Studio Code.

Audience

The documentation for the Component Service is primarily aimed at developers.

Access

You will need Developer access to the Squiz Digital Experience Platform (DXP) Console, with the Component Service enabled. If you do not have the Component Service available in the DXP Console, contact Customer Success.

Installation

The first step to using the Component Service is to install the local development environment so that you can develop and test components locally.

The Component Service uses a local CLI tool . The CLI tool is used to run a local development server and deploy your components to the DXP. Install the CLI tool using Node Package Manager (NPM).

To install the local dev tools:

  1. Access your CLI

  2. Run: npm i -g @squiz/dxp-cli-next

    The -g installs globally. It is recommended that the CLI tool is installed globally rather than per project, as the developer tools will need to be in sync with the server version. You can not use different versions with different projects.

  3. Test the installation has worked by running dxp-next. You will see help text with a list of available commands.

Next steps

Familiarize yourself with the details of the Component Service file structure.

Find out how to use the Component Service. Follow the instructions at Hello world to create and deploy your first component.