Hyperledger Cactus Example - Supply Chain App

Usage

1. Execute the following from:

   docker run \
     --rm \
     --privileged \
     -p 3000:3000 \
     -p 3100:3100 \
     -p 3200:3200 \
     -p 4000:4000 \
     -p 4100:4100 \
     -p 4200:4200 \
     ghcr.io/hyperledger/cactus-example-supply-chain-app:2021-09-08--docs-1312
   

2. Observe the example application pulling up in the logs

   1. the test ledger containers,

   2. a test consortium with multiple members and their Cactus nodes

3. Wait for the output to show the message INFO (api-server): Cactus Cockpit reachable http://0.0.0.0:3100

4. Visit http://0.0.0.0:3100 in your web browser with Javascript enabled

Building and running the container locally

# Change directories to the project root

# Build the dockar image and tag it as "scaeb" for supply chain app example backend
DOCKER_BUILDKIT=1 docker build -f ./examples/supply-chain-app/Dockerfile . -t scaeb

# Run the built image with ports mapped to the host machine as you see fit
# The --privileged flag is required because we use Docker-in-Docker for pulling
# up ledger containers from within the container in order to have the example
# be completely self-contained where you don't need to worry about running
# multiple different ledgers jus this one container.
docker run --rm -it --privileged -p 3000:3000 -p 3100:3100 -p 3200:3200 -p 4000:4000 -p 4100:4100 -p 4200:4200 scaeb

Running the Example Application Locally

Make sure you have all the dependencies set up as explained in BUILD.md

On the terminal, issue the following commands:

1. npm run install-yarn

2. yarn configure

3. yarn start:example-supply-chain

Debugging the Example Application Locally

On the terminal, issue the following commands (steps 1 to 6) and then perform the rest of the steps manually.

1. npm run install-yarn

2. yarn configure

3. yarn build:dev

4. cd ./examples/supply-chain-app/

5. yarn --no-lockfile

6. cd ../../

7. Locate the .vscode/template.launch.json file

8. Within that file locate the entry named "Example: Supply Chain App"

9. Copy the VSCode debug definition object from 2) to your .vscode/launch.json file

10. At this point the VSCode Run and Debug panel on the left should have an option also titled "Example: Supply Chain App" which