-Do not try to connect to the beta network from source yet.
-Visit https://gitlab.com/shardeum/validator/dashboard and use this instead
-local testing may not run great yet. We will update with information on this later
-for now the best use of this repo is to be able to see the code
Make sure you have the following installed and configured (we recommend using nvm/nvm-windows to manage your Node.js and npm versions):
- Node.js (10.x.x)
- npm (6.x.x)
- Git
Then, install the node-gyp
dependencies for your platform listed here.
On Ubuntu, it goes something like this:
$ sudo apt update && sudo apt install python2.7 make g++
$ npm config set python python2.7
$ npm i -g git+https://gitlab.com/shardus/enterprise/tools/shardus-cli.git
$ shardus init myApp https://gitlab.com/shardus/enterprise/applications/coin-app-template.git
$ cd myApp
-
Make code changes to
index.ts
and / orclient.js
-
Start the
seed-node-server
,monitor-server
, and yourindex.ts
server:$ npm start
-
Interact with your
index.ts
server:$ node client.js $ client$ help ...
-
Stop the
seed-node-server
andmonitor-server
, and clean residual run files:$ npm stop && npm run clean
Repeat until desired behavior is achieved...
-
Create a local test network with multiple instances of your
index.ts
server:$ shardus network create --default (uses default settings for prompts)... $ cd instances
-
Start your local test network:
$ shardus network start
-
Interact with your network:
$ node ../client.js $ client$ help ...
-
Stop the network:
$ shardus network stop
-
Clean databases and logs from the last run:
$ shardus network clean
Please read this contribution guide.