Skip to content

Latest commit

 

History

History
165 lines (107 loc) · 4.57 KB

README.md

File metadata and controls

165 lines (107 loc) · 4.57 KB
Raw

vDexNode Dashboard

standard-readme compliant

Download

vDexNode GUI

The application allows you to manage a vDexNode node running in a openDHT network using a set of smart contracts of the EOS blockchain platform.

image_2019-11-01_10-24-39 Screen Shot 2019-11-27 at 9 09 07 AM Screen Shot 2019-11-27 at 9 09 46 AM

Table of Contents

Disclaimer

Disclaimer: this is a test network and the sole purpose of this network is for R&D purposes. The network might not work as intended and you temporarily might not receive VTX at all on a certain day or until issues are resolved. Please report if you have not received your VTX but do not expect this VTX as guaranteed.

Download

You can download the latest release of the application here

Development

Prerequisites

For the application to work, it is recommended to use the YARN package manager, however, with the NPM, the application will also work.

1. Node.js

If you don't have Node.js installed in your system you can follow the official instructions to do that: Node.js install

You can install any LTS or Current version on your machine.

2. Package manager

Option 1: NPM

If you installed the Node.js correctly you already have the latest NPM installed.

Option 2: YARN (recommended)
Ubuntu
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -

echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

sudo apt update

sudo apt install yarn
MacOS

It is assumed that brew is already installed

brew install yarn
Other

You can follow the instructions from official website: YARN

3. Quasar

If you don't have a quasar installed use the following command:

npm install -g @quasar/cli

Installation

# Clone the repo
git clone https://github.com/Volentix/vDexNode-GUI.git
# Go to the project folder
cd vDexNode-GUI
# Install dependencies
# if you are using YARN
yarn
#if you are using NPM
npm install

Usage

Fill the .env file

You can just copy the .env.template file in the root folder and rename it to .env file.

NODES_API=http://95.216.0.79:9080
INSTALLER=https://raw.githubusercontent.com/Volentix/vDexNode-GUI/master/ubuntu-installer/install.sh
README=https://github.com/Volentix/vDexNode/blob/master/README.md
NODE_WAY=readme

#NODE_WAY=installer

# mainnet endpoint
EOS_ENDPOINT=https://eos.greymass.com

# testnet endpoint
# EOS_ENDPOINT=https://api.kylin.alohaeos.com

Running

# Go to the project folder if you're not there
cd vDexNode-GUI
# Run the app
quasar dev -m electron
# or
yarn run dev

Other commands

yarn run lint
yarn run docs
yarn run test #Under development

Build

If you have all the certificates installed in your system, you can build the binaries for several platforms.

yarn run build # build for current user electron platform
yarn run build-all # build for all electron platforms linux|mac|windows|darwin
yarn run build-linux # build for linux electron platform

yarn run publish # build for current user electron platform and upload the binaries as a release on GitHub
yarn run publish-all # Build for all electron platforms and upload the binaries as a release on github
yarn run publish-linux # build for linux electron platform and upload the binary as a release on github

Contributing

See the contributing file!

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

Any optional sections

License

MIT © Volentix Labs.