zarb-go

module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 13, 2021 License: MIT

README

codecov CI Go Report Card Discord

Zarb

Zarb blockchain (https://zarb.network)

Compiling the code

You need to make sure you have install Go. Follow these steps to compile and build Zarb blockchain:

git clone https://github.com/zarbchain/zarb-go.git
cd zarb-go
make

Run zarb version to make sure Zarb is properly compiled and installed in your machine.

Running Zarb

Testnet

To join the TestNet, first you need to create a working directory and then start the node:

zarb init  -w=<working_dir> --testnet
zarb start -w=<working_dir>

Local net

You can create a local node with one validator to test Zerb in your machine:

zarb init -w=<working_dir>
zarb start -w=<working_dir>

Usage of Docker

You can run the Zarb using docker file. Please make sure you have installed docker in your machine.

Pull the docker from docker hub.

docker pull zarb/zarb

Let's create a worksapce at ~/zarb/testnet for the testnet:

docker run -it --rm -v ~/zarb/testnet:/zarb zarb/zarb init -w /zarb --testnet

Now we can run the zarb and join the testnet:

docker run -it -v ~/zarb/testnet:/zarb -p 8080:8080 --name zarb-testnet zarb/zarb start -w /zarb

check "http://localhost:8080" for the list of APIs.

Also you can stop/start docker:

docker stop zarb-testnet
docker start zarb-testnet

Or check the logs:

docker logs zarb-testnet --tail 1000 -f

Contribution

Any ideas are welcome. Feel free to submit any issues or pull requests.

License

The Zarb blockchain is under MIT license.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL