Skip to content

Commit

Permalink
feat: readme part how to run containerized localnet
Browse files Browse the repository at this point in the history
  • Loading branch information
jlehtimaki committed Sep 1, 2023
1 parent 228da9a commit b31e7e8
Showing 1 changed file with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -7,15 +8,14 @@
[![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

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;
Expand All @@ -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 (<https://go.dev>)
- Git Distributed Version Control (<https://git-scm.com>)
- Docker (<https://www.docker.com>)
- GNU Make (<https://www.gnu.org/software/make>)

## Build from Source

Expand All @@ -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

Expand Down

0 comments on commit b31e7e8

Please sign in to comment.