From b31e7e811f9573d31ff8738064479fd29f019e7c Mon Sep 17 00:00:00 2001 From: Joonas Lehtimaki Date: Fri, 1 Sep 2023 12:50:44 +0300 Subject: [PATCH] feat: readme part how to run containerized localnet --- README.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c0eaf023..8b2a2df2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ ![](https://github.com/archway-network/archway/blob/main/banner.png) + # Archway [![Version](https://img.shields.io/github/v/tag/archway-network/archway.svg?sort=semver&style=flat-square)](https://github.com/archway-network/archway/releases/latest) @@ -7,7 +8,6 @@ [![codecov](https://codecov.io/gh/archway-network/archway/branch/master/graph/badge.svg)](https://codecov.io/gh/archway-network/archway) [![License:Apache-2.0](https://img.shields.io/github/license/archway-network/archway.svg?style=flat-square)](https://github.com/archway-network/archway/LICENSE) - The core implementation of the Archway protocol leverages the [Cosmos SDK](https://cosmos.network) and [CosmWasm](https://cosmwasm.com) to reward validators and creators for their contributions to the network. ## System Requirements @@ -15,7 +15,7 @@ The core implementation of the Archway protocol leverages the [Cosmos SDK](https The following specifications have been found to work well: - An x86-64 (amd64) multi-core CPU (AMD / Intel); - - Higher clock speeds are preferred as Tendermint is mostly single-threaded; + - Higher clock speeds are preferred as Tendermint is mostly single-threaded; - 64GB RAM; - 1TB NVMe SSD Storage (disk i/o is crucial); - 100Mbps bi-directional Internet connection; @@ -24,10 +24,10 @@ The following specifications have been found to work well: The following software should be installed on the target system: -- The Go Programming Language (https://go.dev) -- Git Distributed Version Control (https://git-scm.com) -- Docker (https://www.docker.com) -- GNU Make (https://www.gnu.org/software/make) +- The Go Programming Language () +- Git Distributed Version Control () +- Docker () +- GNU Make () ## Build from Source @@ -49,7 +49,28 @@ A docker image for production purposes (no shell access): A docker image is also provided for test setups (shell access): -[Packages: archwayd-debug](https://github.com/orgs/archway-network/packages/container/package/archwayd-debug) +[Packages: archwayd-debug](https://github.com/orgs/archway-network/packages/container/package/archwayd-dev) + +## Running localnet + +There are two ways to run a localnet, local and containerized + +### Containerized + +This solution uses docker-compose and docker on the backend. +To setup new localnet use: + +``` +make localnet +``` + +To continue last localnet used: + +``` +make localnet-continue +``` + +### Local ## Documentation