Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dshuffma-ibm committed Mar 19, 2017
1 parent 5d53288 commit c8e4946
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 23 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ It is strongly recommended that if you have an existing network based on v0.5.3,


- [Marbles - Branch v3.0](https://github.com/ibm-blockchain/marbles/tree/v3.0) **(Experimental)**
- Works with Hyperledger Fabric `v1.0` (getting started tutorial coming soon! 3/17/2017)
- Works with Hyperledger Fabric `v1.0` (getting started tutorial coming soon!)
- Works with the IBM Blockchain Bluemix Service - Plan **HSBN vNext**

***
Expand Down Expand Up @@ -53,6 +53,6 @@ Start the tutorials below to have your own marbles blockchain demo!

## Tutorial / Documentation
- Looking for chaincode documentation? Check out the [learn chaincode](https://github.com/IBM-Blockchain/learn-chaincode) repo - **start here!**
- [Tutorial for Marbles](/docs/tutorial_part1.md)
- [Tutorial for Marbles](/docs/tutorial_start_here.md)

***
2 changes: 1 addition & 1 deletion config/mycreds1.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"alice",
"ava"
],
"port": 3002,
"port": 3001,
"last_startup_hash": "a6b69ade1e3529ae79a3093a7ecd53f687565839"
}
}
Expand Down
2 changes: 1 addition & 1 deletion config/mycreds2.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"cody",
"chuck"
],
"port": 3003,
"port": 3002,
"last_startup_hash": "380c2263aab82a818586b5abaaf96dfd1cdd25be"
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/host_marbles_bluemix.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@
[ibc-js] Deploying Chaincode - Complete
---------------------------------------- Websocket Up ------------------------------------------

1. Marbles is running! Now [Continue tutorial 1](./tutorial_part1.md#use).
1. Marbles is running! Now [Continue tutorial 1](./tutorial_start_here.md#use).
2 changes: 1 addition & 1 deletion docs/host_marbles_bluemix_button.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ This will create a new marble Node.js application **AND** create a new blockchai

1. Simply click this button ->   
[![Deploy to Bluemix](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https://github.com/ibm-blockchain/marbles.git)
1. Once you are up and running [continue tutorial 1](./tutorial_part1.md#use).
1. Once you are up and running [continue tutorial 1](./tutorial_start_here.md#use).
</strike>
2 changes: 1 addition & 1 deletion docs/host_marbles_locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Lets do the very last setup for marbles.

![](/doc_images/localhost4.png)

1. Marbles is all setup! Now [Continue tutorial 1](./tutorial_part1.md#use).
1. Marbles is all setup! Now [Continue tutorial 1](./tutorial_start_here.md#use).
2 changes: 2 additions & 0 deletions docs/install_chaincode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#Work in progress
- please hold
36 changes: 22 additions & 14 deletions docs/tutorial_part1.md → docs/tutorial_start_here.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,9 @@ Using the button will bypass all the setup below, but you will not have much con
This is great for just seeing what marbles is, but you cannot easily play with the code.
</strike>

**Update:** *this version of marbles is not yet compatible with the deploy to Bluemix buttons*
**Update:** *this version of marbles is no longer compatible with the deploy to Bluemix buttons*

**Choose 1 option below:**

- <strike>**Option 1:** [Button Instructions](./host_marbles_bluemix_button.md)</strike>
- **Option 2:** Follow these machine setup [instructions](https://github.com/IBM-Blockchain/learn-chaincode/blob/v2.0/docs/setup.md) to install **Git, Go** and **Node.js**.
- Follow these environment setup [instructions](https://github.com/IBM-Blockchain/learn-chaincode/blob/v2.0/docs/setup.md) to install **Git, Go** and **Node.js**.
- When you have finished come back to this tutorial. Start the next section "Download Marbles" below.

### Download Marbles
Expand All @@ -100,21 +97,20 @@ git clone http://gopkg.in/ibm-blockchain/marbles.v3
```

- This will clone the v3.0 branch to your local system.
- Next run this command to populate the HFC submodule:

```
git submodule update --init --recursive
```

### Get a Network
<a name="getnetwork"></a> Now we need a blockchain network.

**Choose 1 option below:**


- **Option 1:** Create a network with the Bluemix IBM Blockchain Service - [instructions](./use_bluemix_hyperledger.md)

<strike>
- **Option 1:** Create a Bluemix IBM Blockchain network - [instructions](./use_bluemix_hyperledger.md)
</strike>
- **Option 2:** Use a locally hosted Hyperledger Network - [instructions](./use_local_hyperledger.md)
</strike>

^ instructions coming soon

### Host Marbles
<a name="hostmarbles"></a>Finally we need marbles running somewhere.
Expand All @@ -124,11 +120,23 @@ git submodule update --init --recursive
- **Option 1:** Host marbles on Bluemix - [instructions](./host_marbles_bluemix.md)
- **Option 2:** Host marbles locally - [instructions](./host_marbles_locally.md)

***
### Install and Instantiate Chaincode
OK, almost there! Now we need to get our marbles chaincode running.
There are two ways to do this.

Choose the **only** option that is relevant for your setup:

- **Option 1:** Install chaincode with the IBM Blockchain Service - [instructions](./install_chaincode.md)

<strike>
- **Option 2:** Install chaincode with the SDK locally - instructions coming soon!
</strike>

***

#<a name="use"></a>Use Marbles App
1. Open up your browser and browse to [http://localhost:3000](http://localhost:3000) or your Bluemix www route.
1. If you are at this step, you should have your environment setup, blockchain network created, marbles app and chaincode running. Right? If not look up for help (up the page, not literaly upwards).
1. Open up your browser and browse to [http://localhost:3001](http://localhost:3001) or your Bluemix www route.
1. Finally we can test the application. Click the "+" icon on one of your users in the "United Marbles" section

![](/doc_images/use_marbles1.png)
Expand Down
2 changes: 1 addition & 1 deletion docs/use_bluemix_hyperledger.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ The network is all setup. If you want more detail on the IBM Blockchain service,
1. Click the "Service Credentials" link on the very bottom left of the dashboard.
1. This will open the file in your browser. Replace the entire contents of the `mycreds_bluemix.json` file in the root of the `/git/<project>` directory you cloned earlier with this text.
1. Double check that [app.js](../app.js#L154) is using the correct file. Line 154 uses `mycreds_docker_compose.json` and should be commented out. Line 155 with `mycreds_bluemix.json` should NOT be commented out.
1. Continue where you left off in [tutorial 1](./tutorial_part1.md#hostmarbles).
1. Continue where you left off in [tutorial 1](./tutorial_start_here.md#hostmarbles).

</strike>
2 changes: 1 addition & 1 deletion docs/use_local_hyperledger.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@ Maps to:

Once you have edited `mycreds.json` you are ready to run Marbles.

1. Continue where you left off in [tutorial 1](./tutorial_part1.md#hostmarbles).
1. Continue where you left off in [tutorial 1](./tutorial_start_here.md#hostmarbles).

0 comments on commit c8e4946

Please sign in to comment.