Skip to content

Commit 17065f2

Browse files
nickgaskichristo4ferris
authored andcommitted
doc edits - preview & starter kit
Cherry picked from fac2d2e clean up video format change Fabric to fabric starter kit typos and edits [ci skip] Change-Id: I78aa2a9ed2c1e79a18ebcf8a19f27964a5d48959 Signed-off-by: Nick Gaski <[email protected]> Signed-off-by: Christopher Ferris <[email protected]>
1 parent adf1f27 commit 17065f2

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

docs/starter/fabric-starter-kit.md

+23-24
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Fabric Starter Kit
22

3-
This section describes how to set up a self contained environment for
4-
application development with the Hyperledger Fabric. The setup
3+
This section describes how to set up a self-contained environment for
4+
application development with the Hyperledger fabric. The setup
55
uses **Docker** to provide a controlled environment with all the necessary
66
Hyperledger fabric components to support a Node.js application built with
77
the fabric's Node.js SDK, and chaincode written in Go.
88

99
There are three Docker images that, when run, will provide a basic
1010
network environment. There is an image to run a single `peer`, one to run
11-
the `membersrvc` and one to run both your Node.js application and the your
12-
chaincode. See [Application Developer's Overview](app-overview.md) on how the
11+
the `membersrvc`, and one to run both your Node.js application and your
12+
chaincode. See [Application Developer's Overview](../nodeSDK/app-overview.md) on how the
1313
components running within the containers will communicate.
1414

1515
The starter kit comes with a sample Node.js application ready to execute and
@@ -18,7 +18,7 @@ In this mode, the chaincode is built and started prior to the application
1818
making a call to deploy it.
1919

2020
**Note:** The deployment of chaincode in network mode requires that the
21-
Hyperledger Fabric Node.js SDK has access to the chaincode source code and all
21+
Hyperledger fabric Node.js SDK has access to the chaincode source code and all
2222
of its dependencies, in order to properly build a deploy request. It also
2323
requires that the `peer` have access to the Docker daemon to be able to build
2424
and deploy the new Docker image that will run the chaincode. *This is a more
@@ -46,10 +46,9 @@ If you wish, there are a number of chaincode examples near by.
4646
curl -o docker-compose.yml https://raw.githubusercontent.com/hyperledger/fabric/master/examples/sdk/node/docker-compose.yml
4747
```
4848

49-
The docker compose environment uses three docker images. Two are published to
50-
DockerHub. However, the third, we provide you the source to build your own,
51-
so that you can customize to inject your application code for development,
52-
the following [Dockerfile](https://raw.githubusercontent.com/hyperledger/fabric/master/examples/sdk/node/Dockerfile)
49+
The docker-compose environment uses three Docker images. Two are published to
50+
DockerHub. However, with the third, we provide you the source to build your own,
51+
so that you can customize it to inject your application code for development. The following [Dockerfile](https://raw.githubusercontent.com/hyperledger/fabric/master/examples/sdk/node/Dockerfile)
5352
is used to build the base **fabric-starter-kit** image and may be used as
5453
a starting point for your own customizations.
5554

@@ -78,14 +77,14 @@ is located, execute one of following `docker-compose` commands.
7877
docker-compose up
7978
```
8079
81-
Both commands will start three docker containers, to view the container
82-
status try `docker ps` command. The first time this is run the Docker
80+
Both commands will start three Docker containers. To view the container
81+
status use the `docker ps` command. The first time this is run, the Docker
8382
images will be downloaded. This may take 10 minutes or more depending on the
8483
network connections of the system running the command.
8584
86-
```
87-
docker ps
88-
```
85+
```
86+
docker ps
87+
```
8988
9089
You should see something like the following:
9190
@@ -101,34 +100,34 @@ Node.js application is located.
101100
102101
**note:** Be sure to wait 20 seconds after starting the network using the
103102
`docker-compose up` command before executing the following command to allow
104-
the network to initialize.
103+
the network to initialize:
105104
106105
```
107106
docker exec -it starter /bin/bash
108107
```
109108
110109
* From the terminal session in the **starter** container execute the standalone
111-
Node.js application. The docker terminal session should be in the working
110+
Node.js application. The Docker terminal session should be in the working
112111
directory of the sample application called **app.js** (*/opt/gopath/src/github.com/hyperledger/fabric/examples/sdk/node*). Execute
113-
the following Node.js command to run the application.
112+
the following Node.js command to run the application:
114113
115114
```
116115
node app
117116
```
118117
In another terminal session on the host you can view the logs for the peer
119118
by executing the following command (not in the docker shell above, in a new
120-
terminal session of the real system)
119+
terminal session of the real system):
121120
122121
```
123122
docker logs peer
124123
```
125124
126-
* If you wish to run your own Node.js application using the pre build docker
125+
* If you wish to run your own Node.js application using the pre-built Docker
127126
images:
128127
* use the directories in the `volumes` tag under **starter** in the
129128
`docker-compose.yml` file as a place to store your programs from the host
130129
system into the docker container. The first path is the top level system
131-
(host system) and the second is created in the docker container. If you wish
130+
(host system) and the second is created in the Docker container. If you wish
132131
to use a host location that is not under the `/Users` directory (`~` is
133132
under `/Users') then you must add that to the Docker file sharing
134133
under Docker preferences.
@@ -139,18 +138,18 @@ images:
139138
```
140139
* copy or create and edit your application in the `~/mytest` directory as
141140
stated in the `docker-compose.yml` `volumes` tag under **starter** container.
142-
* run npm to install Hyperledger Fabric Node.js SDK in the `mytest` directory
141+
* run npm to install Hyperledger fabric Node.js SDK in the `mytest` directory:
143142

144143
```
145144
npm install /opt/gopath/src/github.com/hyperledger/fabric/sdk/node
146145
```
147146
* run the application from within the **starter** Docker container using the
148-
commands
147+
following commands:
149148

150149
```
151150
docker exec -it starter /bin/bash
152151
```
153-
once in the shell, and assuming your Node.js application is called `app.js`
152+
once in the shell, and assuming your Node.js application is called `app.js`:
154153

155154
```
156155
cd /user/mytest
@@ -167,7 +166,7 @@ the containers from Docker:
167166
docker-compose down
168167
```
169168
or if you wish to keep your changes and just stop the containers, which will
170-
be restarted on the next `up` command
169+
be restarted on the next `up` command:
171170

172171
```
173172
docker-compose kill

0 commit comments

Comments
 (0)