https://github.com/iamnapo/btc-network

⛓️ Tiny module that creates a btc network using docker images.
https://github.com/iamnapo/btc-network

btc btc-network

Last synced: 3 months ago
JSON representation

⛓️ Tiny module that creates a btc network using docker images.

• Host: GitHub
• URL: https://github.com/iamnapo/btc-network
• Owner: iamnapo
• License: mit
• Created: 2019-09-25T20:41:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-08-30T22:58:01.000Z (over 1 year ago)
• Last Synced: 2024-11-08T13:14:23.719Z (3 months ago)
• Topics: btc, btc-network
• Language: C++
• Homepage:
• Size: 9.86 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# btc-network

> Tiny module that creates a btc network using docker images

[![dockerhub](https://img.shields.io/badge/-iamnapo/btc--network-1388c6?logo=docker&logoColor=white&style=for-the-badge&label=)](https://hub.docker.com/r/iamnapo/btc-network)

[![build](https://img.shields.io/github/actions/workflow/status/iamnapo/btc-network/ci.yml?branch=master&style=for-the-badge&logo=github&label=)](https://github.com/iamnapo/btc-network/actions)

[![npm](https://badges.iamnapo.me/npm/@iamnapo/btc-network)](https://www.npmjs.com/package/@iamnapo/btc-network)

## Install

1. If you don't have [Docker](https://www.docker.com/), install it:

   ```sh

   curl -fsSL https://get.docker.com -o get-docker.sh

   sh get-docker.sh

   ```

2. If you don't have [Node.js](https://nodejs.org/en/), install it:

   ```sh

   $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.0/install.sh | bash

   $ export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"

   		[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

   $ nvm i "lts/*"

   ```

3. Install `btc-network` globally:

   ```sh

   $ npm i @iamnapo/btc-network -g

   ```

**_Note:_** If you want a one-liner to do all of the above:

```sh

$ curl -o- https://raw.githubusercontent.com/iamnapo/btc-network/master/install.sh | bash

```

**_Note:_** If you don't want to use node/npm, you can [download the corresponding binary](https://github.com/iamnapo/btc-network/releases/latest). Keep in mind that Docker is still required.

## Usage

**WARNING:** Check the files in [`templates/`](./templates) for the required input structure.

![Usage](./usage.gif)

> `$ btc-network --help` for more info.