qortal-ui/README.md

Qortal Project UI

Decentralizing The World

Building and Running Qortal UI Server from source:

Follow the steps below to download, install, build and run Qortal UI locally on Linux.

Installation

Packages required:

• Node.js
• npm

Easiest way to install the lastest required packages on Linux is via nvm.

sudo apt update && sudo apt install curl -y
sudo rm -rf ~/.nvm (Only for update node version)
curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
source ~/.profile (For Debian based distro)
source ~/.bashrc (For Fedora / CentOS)
nvm ls-remote (Fetch list of available versions)
nvm install v18.20.3 (Latest LTS: Hydrogen supported by Electron V31)
npm --location=global install [email protected]

Adding via binary package mirror will only work if you have set the package path. You can do a node or java build via ports instead by downloading ports with portsnap fetch method.

Verify your installation with node --version

• If you have an older installation of npm, please do not forget to update that with npm update -g

Clone the main UI repo

• git clone https://github.com/Qortal/qortal-ui.git

Installation

In qortal-ui directory, run:

npm install

Build UI server and files

npm run build

Start UI Server ( preferred way )

npm run server &

The "&" at the end puts the UI server in the background.

Run UI using electron

npm run start-electron

Build script (unix-like systems only)

To automate the above process, run ./build.sh, optionally specifying the following options:

-s: run UI server after completing the build
-e: run electron server after completing the build
-w: use 'npm run watch' instead of 'npm run build', to enable hot swapping
-h: show help

Example command to build and run the UI server:

./build.sh -s