You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 22, 2025. It is now read-only.
See [the documentation on Maintainers](https://hyperledger-fabric.readthedocs.io/en/latest/CONTRIBUTING.html#maintainers) to learn about the role of the maintainers and the process to become one.
7
+
8
+
**Active Maintainers**
9
+
10
+
| Name | GitHub |
11
+
|------|--------|
12
+
| Andrew Coleman |[andrew-coleman][andrew-coleman]|
> **Note:** When developing applications for HyperledgerFabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
4
4
5
5
The Hyperledger Fabric Client SDK makes it possible to use APIs to interact with a Hyperledger Fabric blockchain. This readme is directed towards a current or future contributor to this project, and gives an overview of setting up the project locally and running tests. For more information on the SDK, including features and an API reference, please visit the [SDK documentation](https://hyperledger.github.io/fabric-sdk-node/).
6
6
@@ -12,24 +12,20 @@ This project publishes the following npm packages:
12
12
13
13
## Build and Test
14
14
To build and test, the following pre-requisites must be installed first:
15
-
* Node.js, version 10 is supported from 10.15.3 and higher
16
-
* Node.js, version 12 is supported from 12.13.1 and higher
17
-
* npm tool version 6 or higher
18
-
* docker (only required for running integration tests, see below)
15
+
* Node.js
16
+
* Docker (only required for running integration tests, see below)
19
17
20
18
### Run unit tests
21
19
Clone the project and launch the following commands to install the dependencies and perform various tasks.
22
20
23
21
In the project root folder:
24
22
* Install all dependencies via `npm install`
25
23
* Optionally, to generate API docs via `npm run docs`
26
-
* To generate the required crypto material used by the tests, use one of the following patform specific commands:
27
-
* For Linux `npm run installAndGenerateCerts`
28
-
* For mac `npm run installAndGenerateCertsMac`
24
+
* To generate the required crypto material used by the tests, use the npm task `npm run installAndGenerateCerts`
29
25
* To run the unit tests that do not require any additional set up, use `npm run testHeadless`
30
26
31
27
### Run Integration Tests
32
-
Integration tests run on the master branch require the most recent stable Fabric images, which are hosted on Artifactory. A utility script is provided to retrieve non-published docker images, which may be run using the command `npm run pullFabricImages`
28
+
Integration tests run on the main branch require the most recent stable Fabric images, which are hosted on Artifactory. A utility script is provided to retrieve non-published docker images, which may be run using the command `npm run pullFabricImages`
33
29
34
30
Now you are ready to run the integration tests. It is advisable to clear out any previous key value stores that may have cached user enrollment certificates using the command (`rm -rf /tmp/hfc-*`, `rm -rf ~/.hfc-key-store`) prior to testing in isolation.
35
31
@@ -65,4 +61,3 @@ Check the `./release_notes` directory for the release notes of the specified rel
65
61
Check [the documentation](./CONTRIBUTING.md) on how to contribute to this project for the full details.
66
62
67
63
<arel="license"href="http://creativecommons.org/licenses/by/4.0/"><imgalt="Creative Commons License"style="border-width:0"src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <arel="license"href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
0 commit comments