Skip to content
This repository was archived by the owner on Mar 8, 2020. It is now read-only.

Commit 48bef35

Browse files
authored
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
1 parent d62d43d commit 48bef35

File tree

1 file changed

+48
-19
lines changed

1 file changed

+48
-19
lines changed

packages/composer-website/jekylldocs/tutorials/getting-started-playground.md

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,13 @@ The {{site.data.conrefs.composer_full}} Playground is a web development experien
1616

1717
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).
1818

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+
1926
# Prerequisites
2027

2128
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
2532
Test that Docker Engine is installed by running the following command in your terminal or command prompt:
2633

2734
```
28-
docker -v
35+
docker -v
2936
```
3037
3138
You should see the following output in your terminal or command prompt:
3239
3340
```
34-
$ docker -v
35-
Docker version 1.13.0, build 49bf474
41+
$ docker -v
42+
Docker version 1.13.0, build 49bf474
3643
```
3744
3845
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
4249
Test that Docker Compose is installed by running the following command in your terminal or command prompt:
4350
4451
```
45-
docker-compose -v
52+
docker-compose -v
4653
```
4754
4855
You should see the following output in your terminal or command prompt:
4956
5057
```
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
5360
```
5461
5562
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
109116
110117
If you see this error, ensure that all of these ports are free before you run any commands.
111118
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!
130+
131+
---
132+
133+
113134
114135
# <a name="installationoptions"></a>Alternative installation options
115136
@@ -135,14 +156,14 @@ In order to install {{site.data.conrefs.composer_full}} Playground with npm, you
135156
Test that Node.js is installed by running the following command in your terminal or command prompt:
136157
137158
```
138-
node -v
159+
node -v
139160
```
140161
141162
You should see the following output in your terminal or command prompt:
142163
143164
```
144-
$ node -v
145-
v4.6.2
165+
$ node -v
166+
v4.6.2
146167
```
147168
148169
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
152173
Test that npm is installed by running the following command in your terminal or command prompt:
153174
154175
```
155-
npm -v
176+
npm -v
156177
```
157178
158179
You should see the following output in your terminal or command prompt:
159180
160181
```
161-
$ npm -v
162-
3.10.10
182+
$ npm -v
183+
3.10.10
163184
```
164185
165186
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:
166187
167188
```
168-
sudo npm -g upgrade npm
189+
sudo npm -g upgrade npm
169190
```
170191
171192
### Installation
@@ -197,7 +218,11 @@ You can then start {{site.data.conrefs.composer_full}} Playground by running the
197218
198219
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>
199220
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+
---
201226
202227
## <a name="installdocker"></a>Installing with Docker
203228
@@ -210,14 +235,14 @@ In order to install {{site.data.conrefs.composer_full}} Playground with Docker,
210235
Test that Docker Engine is installed by running the following command in your terminal or command prompt:
211236
212237
```
213-
docker -v
238+
docker -v
214239
```
215240
216241
You should see the following output in your terminal or command prompt:
217242
218243
```
219-
$ docker -v
220-
Docker version 1.13.0, build 49bf474
244+
$ docker -v
245+
Docker version 1.13.0, build 49bf474
221246
```
222247
223248
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.
241266
242267
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>
243268
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!
272+
273+
---

0 commit comments

Comments
 (0)