Getting started

Prerequisites

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

You will also need the following software and tools:

  • 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 or IntelliJ Community Edition.

Audience

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

Access

If you want to experience building a component locally, you do not need any special Squiz DXP access and can go straight to Installation.

To deploy and manage components as described in Deploy and use your component in Squiz DXP you need Developer access to the Squiz Digital Experience Platform (DXP) Console, with the Component Service enabled. Contact Customer Success if you do not have the Component Service available in Squiz DXP Console.

You can still continue to Installation while you are granted access to save time.

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 Build and test your first component introductiory tutorial to experience creating a component first-hand.