Prerequisites

Some commands may need the root account permission to execute, please use sudo as needed, or just start the client as root:

sudo -i

Running from source code

If you wish to run the client from source code, please install the following dependences.

Node.js

Running the Client requires installing Node.js.

Check if Node.js is Installed

Open a terminal window.

To check if Node.js is installed, run the following command:

node -v

If Node.js is installed, the terminal will display the version number, such as v20.15.1.

1. If Node.js is installed, ensure that the version is 20.15.1 or higher.

2. If the installed version is lower than 20.15.1 or it is not installed, proceed to the installation below.

Install Node.js Version 20.15.1

To install Node.js version 20.15.1, first ensure your system is updated:

sudo apt update

Install Node.js from the NodeSource repository:

curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs

Verify the installation by checking the Node.js version again:

node -v

This should return v20.15.1 or a higher version if installed successfully.

Git

Check if Git is Installed

To check if Git is installed, run the following command in the terminal:

git --version

If Git is installed, the terminal will display the version number, such as git version 2.25.1.

Install Git if Not Installed

If Git is not installed, you can install it by running the following commands:

sudo apt update
sudo apt install -y git

Verify the installation by checking the Git version:

git --version

This should return the version number of Git, confirming the installation.

​

Yarn

Check if Yarn is Installed

Open a terminal window.

Check if Yarn is installed by running:

yarn -v

Install Yarn if Not Installed

If Yarn is not installed, add the Yarn repository and install it:

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt update
sudo apt install yarn

Verify the installation by checking the Yarn version:

yarn -v

By following these steps, you will ensure that both Node.js (version 20.15.1 or higher) ,Git and Yarn are installed and properly configured on your system.

Running with Docker

If you wish to run the client with docker, please install docker.

1. Download and Run the Official Installation Script

   Docker provides a convenient installation script that you can download and run with the following commands:

   curl -fsSL https://get.docker.com -o get-docker.sh
   sh get-docker.sh

2. Verify the Docker Installation

   Check the Docker version to confirm that the installation was successful:

   docker --version