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 Mar 8, 2020. It is now read-only.
Playground local install instructions fixes (#867)
* tweaks to the Playground local install instructions
* Additional formatting tweaks to playground local install instructions. Added section explaining how to acivate the hlfabric profile.
* Fixing link to be localhost for the local install istructions
Copy file name to clipboardExpand all lines: packages/composer-website/jekylldocs/tutorials/getting-started-playground.md
+48-19Lines changed: 48 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,13 @@ The {{site.data.conrefs.composer_full}} Playground is a web development experien
16
16
17
17
This tutorial will show you how to start a Hyperledger Fabric instance for use with {{site.data.conrefs.composer_full}} Playground by using Docker Compose. If you already have a running instance of Hyperledger Fabric, or you only want to work in "browser only" mode, then skip to [alternative installation options](#installationoptions).
18
18
19
+
**NOTE:** If you've previously used {{site.data.conrefs.composer_full}} Playground or Hyperledger Fabric, but wish to clear everything out and start again, the following commands will delete any running containers and delete all downloaded images (be careful if you're using other Docker images on your machine):
20
+
21
+
```
22
+
docker ps -aq | xargs docker rm -f
23
+
docker images -aq | xargs docker rmi -f
24
+
```
25
+
19
26
# Prerequisites
20
27
21
28
In order to install {{site.data.conrefs.composer_full}} Playground, you need the following software installed:
@@ -25,14 +32,14 @@ In order to install {{site.data.conrefs.composer_full}} Playground, you need the
25
32
Test that Docker Engine is installed by running the following command in your terminal or command prompt:
26
33
27
34
```
28
-
docker -v
35
+
docker -v
29
36
```
30
37
31
38
You should see the following output in your terminal or command prompt:
32
39
33
40
```
34
-
$ docker -v
35
-
Docker version 1.13.0, build 49bf474
41
+
$ docker -v
42
+
Docker version 1.13.0, build 49bf474
36
43
```
37
44
38
45
Verify that no errors occurred, and the version is greater than or equal to 1.12.3. If not, then follow the official instructions for installing Docker Engine: [Install Docker Engine] (https://docs.docker.com/engine/installation/)
@@ -42,14 +49,14 @@ In order to install {{site.data.conrefs.composer_full}} Playground, you need the
42
49
Test that Docker Compose is installed by running the following command in your terminal or command prompt:
43
50
44
51
```
45
-
docker-compose -v
52
+
docker-compose -v
46
53
```
47
54
48
55
You should see the following output in your terminal or command prompt:
49
56
50
57
```
51
-
$ docker-compose -v
52
-
docker-compose version 1.10.0, build 4bd6f1a
58
+
$ docker-compose -v
59
+
docker-compose version 1.10.0, build 4bd6f1a
53
60
```
54
61
55
62
Verify that no errors occurred, and the version is greater than or equal to 1.8. If not, then follow the official instructions for installing Docker Compose: [Install Docker Compose](https://docs.docker.com/compose/install/)
@@ -109,7 +116,21 @@ Verify that no errors occurred. If you see an error similar to the following err
109
116
110
117
If you see this error, ensure that all of these ports are free before you run any commands.
111
118
112
-
If everything started OK, you should be able to access {{site.data.conrefs.composer_full}} Playground by clicking on this link: <a href="http://docker-machine-ip:8080" target="_blank">http://<span></span>docker-machine-ip:8080</a>
119
+
If everything started OK, you should be able to access {{site.data.conrefs.composer_full}} Playground by clicking on this link: <a href="http://localhost:8080" target="_blank">http://<span></span>localhost:8080</a>
120
+
121
+
# Connecting to Hyperledger Fabric
122
+
123
+
The Basic Sample Network is loaded into the UI by default - it's the "Hello World" of {{site.data.conrefs.composer_full}} samples. The Web Browser Connection Profile is in use to start with, so any data you create by testing your model will be stored in browser memory.
124
+
125
+
The docker-compose command you ran also started a Hyperledger Fabric instance that you can activate to have {{site.data.conrefs.composer_full}} Playground connected to a blockchain instance. To do so, head to the Connection Profiles panel of the UI (click the globe icon in the top-right) and activate the "hlfabric" Connection Profile.
126
+
127
+
---
128
+
129
+
>This tutorial is now **complete**. We plan on extending this tutorial with a guided tour of the playground and its features, so stay tuned!
@@ -135,14 +156,14 @@ In order to install {{site.data.conrefs.composer_full}} Playground with npm, you
135
156
Test that Node.js is installed by running the following command in your terminal or command prompt:
136
157
137
158
```
138
-
node -v
159
+
node -v
139
160
```
140
161
141
162
You should see the following output in your terminal or command prompt:
142
163
143
164
```
144
-
$ node -v
145
-
v4.6.2
165
+
$ node -v
166
+
v4.6.2
146
167
```
147
168
148
169
Verify that no errors occurred, and the version is greater than or equal to v4.6.2 or v6.x. If not, follow the official instructions for installing Node.js v6.x: [Node.js] (https://nodejs.org)
@@ -152,20 +173,20 @@ In order to install {{site.data.conrefs.composer_full}} Playground with npm, you
152
173
Test that npm is installed by running the following command in your terminal or command prompt:
153
174
154
175
```
155
-
npm -v
176
+
npm -v
156
177
```
157
178
158
179
You should see the following output in your terminal or command prompt:
159
180
160
181
```
161
-
$ npm -v
162
-
3.10.10
182
+
$ npm -v
183
+
3.10.10
163
184
```
164
185
165
186
Verify that no errors occurred, and the version is greater than or equal to v3.x. If not, upgrade npm to the latest version by running the following command in your terminal or command prompt:
166
187
167
188
```
168
-
sudo npm -g upgrade npm
189
+
sudo npm -g upgrade npm
169
190
```
170
191
171
192
### Installation
@@ -197,7 +218,11 @@ You can then start {{site.data.conrefs.composer_full}} Playground by running the
197
218
198
219
A web browser will be automatically opened once the playground has started, but should that not happen you should be able to access {{site.data.conrefs.composer_full}} Playground by clicking on this link: <a href="http://localhost:8080" target="_blank">http://<span></span>localhost:8080</a>
199
220
200
-
This tutorial is now **complete**. We plan on extending this tutorial with a guided tour of the playground and its features, so stay tuned!
221
+
---
222
+
223
+
>This tutorial is now **complete**. We plan on extending this tutorial with a guided tour of the playground and its features, so stay tuned!
224
+
225
+
---
201
226
202
227
## <a name="installdocker"></a>Installing with Docker
203
228
@@ -210,14 +235,14 @@ In order to install {{site.data.conrefs.composer_full}} Playground with Docker,
210
235
Test that Docker Engine is installed by running the following command in your terminal or command prompt:
211
236
212
237
```
213
-
docker -v
238
+
docker -v
214
239
```
215
240
216
241
You should see the following output in your terminal or command prompt:
217
242
218
243
```
219
-
$ docker -v
220
-
Docker version 1.13.0, build 49bf474
244
+
$ docker -v
245
+
Docker version 1.13.0, build 49bf474
221
246
```
222
247
223
248
Verify that no errors occurred, and the version is greater than or equal to 1.12.3. If not, then follow the official instructions for installing Docker Engine: [Install Docker Engine] (https://docs.docker.com/engine/installation/)
@@ -241,4 +266,8 @@ Verify that no errors occurred.
241
266
242
267
You can then start {{site.data.conrefs.composer_full}} Playground by clicking on this link: <a href="http://localhost:8080" target="_blank">http://<span></span>localhost:8080</a>
243
268
244
-
This tutorial is now **complete**. We plan on extending this tutorial with a guided tour of the playground and its features, so stay tuned!
269
+
---
270
+
271
+
>This tutorial is now **complete**. We plan on extending this tutorial with a guided tour of the playground and its features, so stay tuned!
0 commit comments