From e4c9d15e60137145bedeb89628315e980f1b3551 Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Fri, 13 Jun 2025 08:51:29 -0700 Subject: [PATCH 1/4] fix(README): Updating installation instructions --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4de5b6b..ad0b37d 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,14 @@ Setup instructions: - `node create-wallet.js` 1. Change directory to the `production/docker` folder. 1. Pull the Docker images down from Docker Hub: `docker-compose pull` -1. Build the core software: `docker-compose build --no-cache` +1. Build the back end: `docker-compose build --no-cache bch-dex` +1. Build the front end: `docker-compose build --no-cache dex-ui` 1. Start the Docker containers with `docker-compose up -d` + - It will take about 10 minutes for the bch-dex to sync with the network and display tokens for sale. 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. -1. You can add the 12-word mnemonic from the `wallet.json` file to the the web wallet, which will mirror your wallet in the UI, and allow you to perform basic wallet functions (send and receive BCH and tokens). +1. You will be presented with a login screen. Click the sign-up tab, enter an email and password to create an account. This information is stored locally on bch-dex, it is not set to a third party. +1. Once logged in, you can retrieve your BCH and SLP addresses, to fund your wallet. + ## Blockchain Infrastructure From b01d15a67dcd22ede1482efec7bbdc53cdc5b548 Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Fri, 13 Jun 2025 08:52:06 -0700 Subject: [PATCH 2/4] Editing README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ad0b37d..b7c0b76 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Setup instructions: 1. Build the back end: `docker-compose build --no-cache bch-dex` 1. Build the front end: `docker-compose build --no-cache dex-ui` 1. Start the Docker containers with `docker-compose up -d` - - It will take about 10 minutes for the bch-dex to sync with the network and display tokens for sale. + 1. It will take about 10 minutes for the bch-dex to sync with the network and display tokens for sale. 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. You will be presented with a login screen. Click the sign-up tab, enter an email and password to create an account. This information is stored locally on bch-dex, it is not set to a third party. 1. Once logged in, you can retrieve your BCH and SLP addresses, to fund your wallet. From 67a9914a8bf7151dd605708009b28322da48df08 Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Fri, 13 Jun 2025 08:52:54 -0700 Subject: [PATCH 3/4] Editing README --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b7c0b76..f5bdb90 100644 --- a/README.md +++ b/README.md @@ -31,21 +31,21 @@ The above software is orchestrated using [Docker](https://www.docker.com/) and D Setup instructions: -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: +- Follow the direction in [this Gist](https://gist.github.com/christroutner/a39f656850dc022b60f25c9663dd1cdd) to install Node.js, Docker, and Docker Compose. +- Clone the repository with `git clone https://github.com/Permissionless-Software-Foundation/bch-dex` and enter it with `cd bch-dex`. +- Install dependencies by running `npm install` +- Create a wallet: - `cd production/scripts` - `node create-wallet.js` -1. Change directory to the `production/docker` folder. -1. Pull the Docker images down from Docker Hub: `docker-compose pull` -1. Build the back end: `docker-compose build --no-cache bch-dex` -1. Build the front end: `docker-compose build --no-cache dex-ui` -1. Start the Docker containers with `docker-compose up -d` - 1. It will take about 10 minutes for the bch-dex to sync with the network and display tokens for sale. -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. You will be presented with a login screen. Click the sign-up tab, enter an email and password to create an account. This information is stored locally on bch-dex, it is not set to a third party. -1. Once logged in, you can retrieve your BCH and SLP addresses, to fund your wallet. +- Change directory to the `production/docker` folder. +- Pull the Docker images down from Docker Hub: `docker-compose pull` +- Build the back end: `docker-compose build --no-cache bch-dex` +- Build the front end: `docker-compose build --no-cache dex-ui` +- Start the Docker containers with `docker-compose up -d` + - It will take about 10 minutes for the bch-dex to sync with the network and display tokens for sale. +- 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. +- You will be presented with a login screen. Click the sign-up tab, enter an email and password to create an account. This information is stored locally on bch-dex, it is not set to a third party. +- Once logged in, you can retrieve your BCH and SLP addresses, to fund your wallet. ## Blockchain Infrastructure From f64795706deb655a40cd71826dcbfbbe4caf8c57 Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Fri, 13 Jun 2025 08:58:11 -0700 Subject: [PATCH 4/4] Editing README --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5bdb90..344c543 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Setup instructions: - Build the front end: `docker-compose build --no-cache dex-ui` - Start the Docker containers with `docker-compose up -d` - It will take about 10 minutes for the bch-dex to sync with the network and display tokens for sale. -- 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. +- Open a web browser and navigate to `http://localhost:4500`. - You will be presented with a login screen. Click the sign-up tab, enter an email and password to create an account. This information is stored locally on bch-dex, it is not set to a third party. - Once logged in, you can retrieve your BCH and SLP addresses, to fund your wallet. @@ -52,6 +52,11 @@ Setup instructions: bch-dex requires a [Cash Stack](https://cashstack.info) back end in order to connect to the blockchain. By default, the Docker containers connect to [free-bch.fullstack.cash](https://free-bch.fullstack.cash/). Several community-provided servers are provided and can be [viewed here](https://consumers.psfoundation.info/consumers.json). The back end can be changed by setting the `CONSUMER_URL` environment variable in the `docker-compose.yml` file. +## Environment Variables + +- `DISABLE_NEW_ACCOUNTS` - If set, only the admin user can create new accounts. The sign-up tab becomes non-functional. Useful for controlling access to your instance of bch-dex. +- `ADMIN_PASSWORD` - Sets the password for the admin user. This can be used with the [createUser.js script](/util/users/production/createUser.js) to add new users to the system, if the `DISABLE_NEW_ACCOUNTS` env var is set. + ## License [MIT](./LICENSE.md)