From 4303efdb43b0d08b72d906b1bfbc26d421d644a7 Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Sun, 1 May 2022 13:03:31 -0700 Subject: [PATCH] fix(README): Updating readme --- README.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 3153606..e9ea476 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ This repository contains the back end code. The user interface is contained in t ## Media - [High-level Overview of bch-dex](https://youtu.be/LVX8CLi4sHw) (Video) - [Developer walk-through for installing and hacking on bch-dex](https://youtu.be/T5XI43-SWJo) (Video) + - This video is out of date. Follow the instructions below. ## Participate This is an open source project, and we encourage other JavaScript developers to participate in its creation and maintenance. We have two chat rooms for the community: @@ -33,19 +34,17 @@ The above software is orchestrated using [Docker](https://www.docker.com/) and D Instructions for setting up Node.js, Docker, and Docker Compose can be found in [this Gist](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd). Walk-through videos can also be found on the [PSF Videos page](https://psfoundation.cash/video/). -Building the Docker containers and getting the app working involve these steps: +Here are the steps involved in setting up bch-dex: 1. Follow the direction in [this Gist](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd) to install Node.js, Docker, and Docker Compose. 1. Clone the repository with `git clone https://github.com/Permissionless-Software-Foundation/bch-dex` and enter it with `cd bch-dex`. 1. Install dependencies by running `npm install` -1. Create a wallet by executing the [create-wallet.js script](./production/scripts/create-wallet.js) with `node create-wallet.js` -1. Move the `wallet.json` file to the `bch-dex` folder in either the [x86 Docker folder](./production/docker/bch-dex) or the [RPi Docker folder](./production/rpi-docker/bch-dex/) depending on your hardware target. -1. Change directory to the `docker` or `rpi-docker` folder depending on your hardware target. -1. Build the Docker containers with `docker-compose build --no-cache`. +1. Create a wallet: + - `cd production/scripts` + - `node create-wallet.js` +1. Change directory to the `production/docker` or `production/rpi-docker` folder depending on your hardware target. +1. Pull the Docker images down from Docker Hub: `docker-compose pull` 1. Start the Docker containers with `docker-compose up -d` -1. Wait for the containers to run for about a minute, then bring them down with `docker-compose down`. That will create the needed folders in `production/data`. -1. Copy the `swarm.key` into the `production/data/go-ipfs/data/` directory. This will allow the IPFS node to connect to the PSF private network. -1. Bring the containers back up with `docker-compose up -d`. 1. Wait for the P2WDB to sync and populate bch-dex with trade data. You can monitor it with `docker logs --tail 20 -f p2wdb`. 1. Open a web browser and navigate the `http://localhost:4500`. You'll be able to see new Offers as they come in and are detected by bch-dex. 1. To take the other side of the trade, click the `Take` button in the UI. @@ -55,15 +54,15 @@ Building the Docker containers and getting the app working involve these steps: ### Applying Software Updates As this is an active project, software updates will happen frequently. To apply a software update, perform these steps. -
    -
  1. Enter the `docker` or `rpi-docker` folder, depending on your hardware target.
    2. -
  2. Bring down the Docker containers with `docker-compose down`.
    3. -
  3. Pull in the software updates with `git pull`
    4. -
  4. Update dependencies with `npm install`
    5. -
  5. Rebuild the Docker containers with `docker-compose build --no-cache`
    6. -
  6. Clean up disk space by deleting old Docker images with `./cleanup-images.sh`
    7. -
  7. Start the Docker containers with `docker-compose up -d`
    8. -
+ +1. Enter the `docker` or `rpi-docker` folder, depending on your hardware target. +1. Bring down the Docker containers with `docker-compose down`. +1. Pull in the software updates with `git pull` +1. Update dependencies with `npm install` +1. Pull new Docker images with `docker-compose pull` +1. Clean up disk space by deleting old Docker images with `./cleanup-images.sh` +1. Start the Docker containers with `docker-compose up -d` + Sometimes it may be necessary to delete the databases before applying a software update. This can be done by stopping the Docker containers and deleting the `production/data` directory. When the Docker containers are restarted, they will recreate that directory. The P2WDB will re-sync and bch-dex will be populated with fresh trade data.