Skip to content

Commit

Permalink
docs(readme): new images in READMEs, start script fix in root
Browse files Browse the repository at this point in the history
Just leaving this separately as an FYI, but prior to merging
would be great if this got squashed.

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
  • Loading branch information
petermetz committed Mar 25, 2021
1 parent 6046320 commit 02af31c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ As blockchain technology proliferates, blockchain integration will become an inc
--privileged \
-p 3000:3000 \
-p 3100:3100 \
-p 3200:3200 \
-p 4000:4000 \
-p 4100:4100 \
hyperledger/cactus-example-supply-chain-app:2021-02-05-f89a37a
-p 4200:4200 \
hyperledger/cactus-example-supply-chain-app:2021-03-24-feat-362
```
2. Wait for the output to show the message `INFO (api-server): Cactus Cockpit reachable http://0.0.0.0:3100`
3. Visit http://localhost:3100 in a web browser with Javascript enabled
Expand Down
10 changes: 6 additions & 4 deletions examples/supply-chain-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@
--privileged \
-p 3000:3000 \
-p 3100:3100 \
-p 3200:3200 \
-p 4000:4000 \
-p 4100:4100 \
hyperledger/cactus-example-supply-chain-app:2021-02-05-f89a37a
-p 4200:4200 \
hyperledger/cactus-example-supply-chain-app:2021-03-24-feat-362
```
2. Observe the example application pulling up in the logs
1. the test ledger containers,
Expand All @@ -33,14 +35,14 @@ DOCKER_BUILDKIT=1 docker build -f ./examples/supply-chain-app/Dockerfile . -t sc
# 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 4000:4000 -p 4100:4100 scaeb
docker run --rm -it --privileged -p 3000:3000 -p 3100:3100 -p 3200:3200 -p 4000:4000 -p 4100:4100 -p 4200:4200 scaeb
```

## Configuring and running the example as a process

1. If the `cactus-example-supply-chain-frontend` is in another directory from the default or need expose the API in another port, check the `process.env`
2. Execute the following command:
```

```
npm run start
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"generate-api-server-config": "node ./tools/generate-api-server-config.js",
"start:api-server": "node ./packages/cactus-cmd-api-server/dist/lib/main/typescript/cmd/cactus-api.js --config-file=.config.json",
"start:cockpit": "lerna run --scope '*/cactus-cockpit' --stream serve:proxy",
"start:example-supply-chain": "cd ./examples/supply-chain-app/ && npm run start",
"start:example-supply-chain": "cd ./examples/supply-chain-app/ && npm i --no-package-lock && npm run start",
"clean": "del-cli \"./packages/cactus-*/{dist,.nyc_output,src/main/typescript/generated/openapi/typescript-axios/*}\"",
"lint": "eslint '*/*/src/**/*.{js,ts}' --quiet --fix",
"tsc": "lerna run tsc",
Expand Down

0 comments on commit 02af31c

Please sign in to comment.