Skip to content

Latest commit

 

History

History
51 lines (28 loc) · 2.05 KB

basic_requirements.md

File metadata and controls

51 lines (28 loc) · 2.05 KB

Basic requirements

RSK Node

If you don't use docker you need to have a running RSK node version ARROWHEAD-6.3.1 or higher.

Yarn

We use yarn version v1.22.0 for package management.

Installation instructions at Yarn's site. Check the install by running yarn version.

Node & NPM

We use Node version v12.18.3.

Installation instructions at Node's site. Check the install by running node -v.

The Node package manager or NPM we use for managing node packages is NPM version 6.14.6.

Npx & Truffle

An important tool we use for interacting with blockchain is Truffle version v5.0.33.

You can follow the installation guide in the official site.

We run all truffle commands with the prefix npx. This is to execute node packages using the project's version of NPM.

Checking the install by running npx truffle version

The configuration file is truffle.js.Please see Truffle's documentation for details about this file and how to use it .

Docker

We recommend following the official documentation for installing Docker and keeping it updated.

You need to install docker and docker-compose

Running on macOS

To run the project using Docker on a Mac, please follow these steps or the scripts and web apps will not work.

  • Patch readlink The startup scripts assume that GNU's readlink command is available. But MacOS ships with BSD's readlink, which is incompatible with GNU's version. So we must patch readlink. This can be done using Homebrew as follows:
brew install coreutils
ln -s /usr/local/bin/greadlink /usr/local/bin/readlink

After this step, you must make sure that your PATH variable gives priority to /usr/local/bin over /usr/bin. You can check this with which readlink, which should output /usr/local/bin/readlink. Alternatively try executing readlink -f ., if it works you're ok.