Skip to content

Commit 64e4aa2

Browse files
authored
Merge pull request hyperledger-indy#834 from Artemkaaas/feature/nodejs-gsg
NodeJS Gettint-Started Guide
2 parents 4459d2f + b0c0f94 commit 64e4aa2

File tree

6 files changed

+5487
-0
lines changed

6 files changed

+5487
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
cargo-registry
22
target
33
build
4+
node_modules
45
.idea
56
*.iml
67
.venv

samples/nodejs/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Getting started with the node.js wrapper
2+
3+
* Make sure you have libindy installed. Checkout the guides [here](https://github.com/hyperledger/indy-sdk/tree/master/doc).
4+
* On Linux, export the `LD_LIBRARY_PATH` environment variable to point to the `libindy.so` parent directory, or copy libindy.so to `/usr/lib/libindy.so`.
5+
* On Mac OS, you must have `libindy.dylib` at `/usr/local/lib/libindy.dylib` before running npm install.
6+
* Inside `samples/nodejs/`
7+
* Make sure you have a running ledger with `npm run ledger`. You must have docker installed.
8+
* Then run `npm run build` and `npm start`.
9+
10+
### Troubleshooting
11+
12+
* If you get an error on the npm install, make sure that LD\_LIBRARY\_PATH is defined or that the library is in the correct directory. See above.
13+
* If you get an `CommonInvalidState` indy error, try rebuilding the ledger with the `--no-cache` docker flag.
14+
* If you just can't figure out why you are getting an indy error, try it with `RUST_LOG=INFO` to see the rust logs.
15+
16+
See documentation for the wrapper at [npmjs.com](https://www.npmjs.com/package/indy-sdk#installing).
17+
18+
### Ready to start consuming indy-sdk?
19+
This example pulls the wrapper from this repository, but you can download it yourself from the npm registery with `npm i indy-sdk`.

0 commit comments

Comments
 (0)