For the best viewing experience, please turn your phone to portrait mode.

Lisk Elements Setup

Pre-Installation

Lisk Elements requires Node.js as the underlying engine for code execution.
This document describes how to install Node and NPM for installation via NPM.

Determine if your platform can run Node

Supported Platforms
  • Windows 10
  • macOS
  • Linux
Not Supported
  • Platforms without NodeJS 6.3.x or higher

Install Node

Node.js is supported on most operating systems.
Follow the instructions for your operating system on the Node.js downloads page.
You will need version 6.3.x or higher.

NPM is automatically installed along with Node.js.

Verify Installation

Confirm that Node.js and NPM have been successfully installed by running

node --version
npm --version

Installation

This section details how to install Lisk Elements for a given distribution.

As all Packages in Lisk Elements are independent from each other, they can be installed separately.

Installation via NPM

To install the latest version of Lisk Elements for use as a dependency in a Node.js project, please proceed with the following:

Complete library

npm install --save lisk-elements

Specific package

npm install --save @liskhq/<package-name>

where <package-name> can be any of the sub packages in Lisk Elements.

For concrete code examples for each package, check the Packages section.

Upon successful completion, NPM will add the Lisk Elements package to your package.json file.

Load via CDN

Include the following script using the following HTML. The lisk variable will be exposed.

Client library

<script src="https://js.lisk.io/lisk-client-1.1.0.js"></script>

Or minified:

<script src="https://js.lisk.io/lisk-client-1.1.0.min.js"></script>

where <package-name> can be any of the sub packages in Lisk Elements.

For concrete code examples for each package, check the Packages section.

Install Lisk Elements from Source

Clone the Lisk Elements repository using Git and install the dependencies:

git clone https://github.com/LiskHQ/lisk-elements.git
cd lisk-elements
git checkout master
npm install
npm run build

What's next?
Upgrade