Skip to main content
Version: Next

Installation

There is a separated library that is managing replay, and is providing the functionality of Replay SDK.

Prerequisites​

You'll need an access for this repository, in order to be able to install it.

If you don't have access to these repositories, you can create a Jira ticket using this template link:

Fill in Summary with "Gitlab Project Access Request"

Fill in Gitlab Group with "WEB"

Fill in Gitlab Permissions with "Developer"

Fill in Details with the following:

Could you provide me with access to the following repos:
- <https://gitlab.com/picsart/web/libraries/web-replay-sdk>

Fill in Approver, Access for and Gitlab username with your personal data and submit the ticket.

Create a Personal Access Token for GitLab: Generate a GitLab Personal access token.

Open this link https://gitlab.com/-/profile/personal_access_tokens. Mark all checkboxes, set token name, and click Create personal access token button. Copy generated token.

Add @picsart registry to your npm global configs using the following command:

  • npm config set -- '@picsart:registry' 'https://gitlab.com/api/v4/packages/npm/'
  • npm config set -- '//gitlab.com/api/v4/packages/npm/:_authToken' '<your personal access token>'

NodeJS Version​

You will need Node.js version 20. If you don't have it yet just download one and install.

caution
  • When installing Node.js, it is recommended to check all checkboxes related to dependencies.

To check whether you have Node.js installed and verify its version, use the following terminal command:

node -v

To update Node.js version you can use the package manager you used for the installation. In case of homebrew you can run the commands below, in this order:

brew update
brew doctor
brew upgrade node

Alternatively, you can use NVM (Node Version Manager).

The CLI project template includes a .nvmrc file.

Slack Support​

If you have any questions or issues, you can find help in the #replay-sdk-support Slack channel.

Installing the package​

Run following command in the root of your repository:

npm i @picsart/web-replay-sdk

or if you're using yarn

yarn add @picsart/web-replay-sdk

Check this link for the supported API