Source code setup

The installation from source code is designed for anyone wishing to develop on the Lisk Core codebase. It also comes with an extensive test-suite which is described in the README.md. An installation performed from the source code enables a developer to work on the latest codebase of Lisk Core, which may not have been tagged for a release yet.

Pre-Install

To complete the installation some prerequisites need to be fulfilled. If you have already performed these, then please proceed to the Installation chapter.

Requirements

Supported Platforms
  • Ubuntu 18.04 (LTS) x86_64

  • Ubuntu 20.04 (LTS) x86_64

  • MacOS x86_64

Git

Git is used for cloning and updating Lisk as displayed below:

  • Ubuntu

  • MacOS

sudo apt install git
brew install git

Node.js

Node.js serves as the underlying engine for code execution. There are several different methods and version managers used to install Node.js on your system. Please ensure the latest LTS version is used. It is recommended to deploy one of the following two versions shown below:

  • Option A - Node version manager

  • Option B - Node.js package

It is recommended to use a Node version manager such as NVM. NVM is a bash script that enables the management of multiple active Node.js versions.

  1. Install NVM and follow the official instructions here.

  2. Install the latest LTS version of Node.js using NVM with the following command shown below:

nvm install 12.20.1

If NVM or other package managers are not required, it is possible to install the Node package globally as shown in the following commands below:

Ubuntu

curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
sudo apt-get install -y nodejs

MacOS

For MacOS, please execute the following command below:

brew install node@12.20.1

PM2 (optional)

Install PM2 for managing the start and stop of the application process in the background as shown below:

npm install pm2 -g

Installation

This section details how to install Lisk Core from Source code. When completed, a functioning node on the Lisk network will exist.

Installing Lisk from Source code

git clone https://github.com/LiskHQ/lisk-core.git (1)
cd lisk-core                  (2)
git checkout v3.0.0-beta.2 -b v3.0.0-beta.2 (3)
npm install --global (4)
1 Clone the repository.
2 Navigate into the lisk-core root folder.
3 Check out the latest release tag.
4 Install dependencies
Please check for the latest release in core releases.

To test that Lisk Core is built and configured correctly, execute the following command below to connect to the network:

lisk-core start --network devnet
# From other terminal
lisk-core node:info

If the process is running correctly, no errors are thrown in the logs.

Post-installation (optional)