Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 2.22 KB

10-installation.md

File metadata and controls

73 lines (51 loc) · 2.22 KB

Installation

Clone the project and its submodules with git.

git clone --recursive https://github.com/LedgerProject/SafePKT safepkt

Components

ℹ️ This section can be skipped for the installation process
unless you'd like to have more details about the components themselves.

Requirements

Here is a list of all requirements:

  • Rust and its development tools
  • Docker
  • Node.js

Docker

Follow the official instructions to install Docker,
as the backend depends on Docker engine to run containers based on an image,
which encapsulates the Rust Verification Tools.

Rust

  • Rust-related requirements can be installed with rustup by running
make install-backend-deps

⚠️ this command execution may take a while as a container image embedding the Rust Verification Tools
will be downloaded by default.

Node.js

We also recommend the installation of a Node.js version management tool like one of the following for the frontend development:

After selecting the latest LTS (Node.js 14.x at the time of writing), install the frontend JavaScript dependencies by running

## Install the latest matching LTS with nvm
#$ nvm install $(nvm ls-remote | \grep 'v14.*' | tail -n1 | awk '{print $1}')
make install-frontend-deps

Configuration

Configuration files with sensitive default values can be copied for both the backend and the frontend.
They can also be customized to serve requests from custom hosts and ports.

make copy-configuration-files

Table of contents