Installation

Installation

To install ZDK modules in your project, you first need to configure your npm registry and then install the desired modules.


1. Configure npm registry

Run the following command to add the ZDK package registry to your .npmrc file:

.npmrc
echo @zdk:registry=https://gitlab.com/api/v4/projects/46817063/packages/npm/ >> .npmrc

This ensures npm knows where to download the ZDK packages from.

2. Install ZDK modules

Run the following command to install all core modules:

.npmrc
npm i @zdk/core_module @zdk/room_module @zdk/chats_module @zdk/room_chat_module @zdk/conference_module @zdk/devices_module @zdk/user_module @zdk/web_socket_module @zdk/event_module @zdk/event_chat_module

Choosing modules You do not need to install all modules if your application doesn’t use them.


Tip: See the Introduction page for a full list of available modules and their dependencies.

Always install @zdk/core_module — it is required by all other modules.