-
Notifications
You must be signed in to change notification settings - Fork 275
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(examples): supply chain app example
The idea is to have a very quickly testable demonstration of how Cactus can be used to develop an (overly simplistic) business use case that involves transacting over multiple ledgers. This example does not yet provide an exhaustive example on how to implement atomic swaps for example, it is purely aimed at showing how code can be written with the help of Cactus to perform basic tasks on different ledgers. Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
- Loading branch information
Showing
91 changed files
with
22,330 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Hyperledger Cactus Example - Supply Chain App | ||
|
||
|
||
> <p style="color:red"> | ||
> **WORK IN PROGRESS** | ||
> --- | ||
> </p> | ||
> | ||
> <p style="color:red"> | ||
> **NOT YET OPERATIONAL** | ||
> --- | ||
> </p> | ||
## Usage | ||
|
||
1. Build the project as instructed by the [BUILD.md](../../BUILD.md) file. | ||
2. Execute the following while standing in the project root directory: | ||
```sh | ||
cd examples/supply-chain-app | ||
npm i | ||
npm start | ||
``` | ||
3. Observe the example application pulling up | ||
1. the test ledger containers, | ||
2. a test consortium with multiple members and their Cactus nodes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
{ | ||
"name": "@hyperledger/cactus-example-supply-chain-backend-app", | ||
"version": "0.2.0", | ||
"description": "An example project demonstrating how Cactus can be used for cross-chain dapp development.", | ||
"scripts": { | ||
"start": "node ./node_modules/.bin/cactus-example-supply-chain-backend", | ||
"start-direct": "node ./node_modules/@hyperledger/cactus-example-supply-chain-backend/dist/lib/main/typescript/supply-chain-app-cli.js" | ||
}, | ||
"private": true, | ||
"publishConfig": { | ||
"access": "restricted" | ||
}, | ||
"engines": { | ||
"node": ">=10", | ||
"npm": ">=6" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/hyperledger/cactus.git" | ||
}, | ||
"keywords": [ | ||
"Hyperledger", | ||
"Cactus", | ||
"Blockchain Integration", | ||
"Distributed Ledger Technology" | ||
], | ||
"author": { | ||
"name": "Hyperledger Cactus Contributors", | ||
"email": "cactus@lists.hyperledger.org", | ||
"url": "https://www.hyperledger.org/use/cactus" | ||
}, | ||
"contributors": [ | ||
{ | ||
"name": "Please add yourself to the list of contributors", | ||
"email": "your.name@example.com", | ||
"url": "https://example.com" | ||
}, | ||
{ | ||
"name": "Peter Somogyvari", | ||
"email": "peter.somogyvari@accenture.com", | ||
"url": "https://accenture.com" | ||
} | ||
], | ||
"license": "Apache-2.0", | ||
"bugs": { | ||
"url": "https://github.com/hyperledger/cactus/issues" | ||
}, | ||
"homepage": "https://github.com/hyperledger/cactus#readme", | ||
"dependencies": { | ||
"@hyperledger/cactus-example-supply-chain-backend": "file:../../packages/cactus-example-supply-chain-backend" | ||
}, | ||
"devDependencies": {} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.