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
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.
To complete the installation some prerequisites need to be fulfilled. If you have already performed these, then please proceed to the Installation chapter.
Git is used for cloning and updating Lisk as displayed below:
Node.js serves as the underlying engine for code execution.
|The correct version for NPM(6) is installed automatically with version 12 of Node.js.|
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.
Install NVM and follow the official instructions here.
Install the latest LTS version of Node.js using NVM with the following command shown below:
nvm install 12.22.7
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:
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - sudo apt-get install -y nodejs
For MacOS, please execute the following command below:
brew install firstname.lastname@example.org
Install PM2 for managing the start and stop of the application process in the background as shown below:
npm install pm2 -g
This section details how to install Lisk Core from Source code. When completed, a functioning node on the Lisk network will exist.
git clone https://github.com/LiskHQ/lisk-core.git (1) cd lisk-core (2) git checkout v3.0.2 -b v3.0.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.|
|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.
It is recommended to use a process manager like PM2 to run Lisk Core in the background.
Check the guide Process management with pm2 for more information.
It is recommended to set up a log rotation, because the log of Lisk Core files can grow very big over time.
Check the guide Managing logs in the SDK docs for more information.