Skip to content

Commit

Permalink
Merge pull request #94 from torresashjian/develop
Browse files Browse the repository at this point in the history
Update docs to reflect refactoring
  • Loading branch information
torresashjian authored Sep 24, 2019
2 parents dfb5c4b + a8c61a6 commit 95a86ab
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 26 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

Developing blockchain solutions with today’s technology is challenging given the lack of tooling and standardization. Project Dovetail™ by TIBCO LABS™ addresses these issues by providing a graphical interface for modeling smart contracts, making them easier to write, visualize, test, and audit, all without deep programming experience.

Logic is abstracted from low-level code, and contracts can be deployed into different blockchain stacks with little or no change.
Logic is abstracted from low-level code, and contracts can be developed for different blockchain stacks with little or no code.
On-chain and off-chain computation can become more seamless, time to market is improved, and the risk of technology lock-in is reduced. Project Dovetail makes your smart contracts smarter.
<br/>

Expand Down
7 changes: 4 additions & 3 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,20 @@
## Labs

- [Labs](ch02-00-labs.md)
- [IoU Tutorial](ch02-01-iou-tutorial.md)
- [Corda IoU Tutorial](ch02-01-iou-tutorial.md)
- [Model Smart Contract](ch02-02-model.md)
- [Import Model](ch02-03-import.md)
- [Implement Smart Contract](ch02-04-implement.md)
- [Export Smart Contract](ch02-05-export.md)
- [Generate Fabric Artifacts](ch02-06-generate-hf.md)
- [Test on Fabric](ch02-07-test-hf.md)
<!---- [Generate Fabric Artifacts](ch02-06-generate-hf.md)
- [Test on Fabric](ch02-07-test-hf.md)-->
- [Generate Corda Artifacts](ch02-08-generate-corda.md)
- [Test on Corda](ch02-09-test-corda.md)
- [Implement CorDapps Flows](ch02-09-01-cordapp-impl.md)
- [Generate CorDapps](ch02-09-01-cordapp-gen.md)
- [Start up nodes](ch02-09-02-start-nodes.md)
- [Run test cases](ch02-09-03-test-cases.md)
- [Fabric Sample and Tutorials](ch02-02-fabric-samples.md)

## Contribute

Expand Down
31 changes: 24 additions & 7 deletions src/ch01-01-installation.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,43 @@
## Installing the Project Dovetail Studio
Installing the Project Dovetail Studio is quite simple just follow these steps:

1.- Download the latest version for your os architecture.
1.- Download the latest version for your os architecture and your blockchain target.

> You can find the latest release [here](https://github.com/TIBCOSoftware/dovetail/releases/tag/v0.1.3)
> You can find the latest release [here](https://github.com/TIBCOSoftware/dovetail/releases/latest)
Or you can just execute this commands


> For Hyperledger fabric development:
```
mkdir dovetail_installation
cd dovetail_installation
curl -OL https://github.com/TIBCOSoftware/dovetail/releases/download/v0.1.3/TIB_dovetail_0.1.3_macosx_x86_64.zip
curl -OL https://github.com/TIBCOSoftware/dovetail/releases/download/v0.2.0/TIB_dovetail-fabric_0.2.0_macosx_x86_64.zip.zip
```

> Change the version or architecture of the url according to your environment.
> For R3 Corda development:
```
mkdir dovetail_installation
cd dovetail_installation
curl -OL https://github.com/TIBCOSoftware/dovetail/releases/download/v0.2.0/TIB_dovetail-corda_0.2.0_macosx_x86_64.zip.zip
```

2.- Unzip the downloaded release (for example on mac) (from dovetail_installation folder).
> For Multitarget development:
```
mkdir dovetail_installation
cd dovetail_installation
curl -OL https://github.com/TIBCOSoftware/dovetail/releases/download/v0.2.0/TIB_dovetail-multitarget_0.2.0_macosx_x86_64.zip.zip
```



2.- Unzip the downloaded release (for example on mac) (from dovetail_installation folder).

```
unzip TIB_dovetail_0.1.3_macosx_x86_64.zip
unzip TIB_dovetail-fabric_0.2.0_macosx_x86_64.zip
```

## Starting Dovetail Studio
Expand All @@ -29,7 +46,7 @@ To get started with your downloaded version of the Dovetail Studio in the previo
1.- Run studio

```
dovetail/0.1/bin/run-studio.sh eula-accept
dovetail/0.2/bin/run-studio.sh eula-accept
```

## Launching Dovetail Studio
Expand Down
8 changes: 4 additions & 4 deletions src/ch01-02-dovetail-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
The dovetail cli is a tool to mainly generate smart contracts for a given model built using ui tool [Dovetail Studio](ch01-01-installation.md), so we recommend you to learn how to do that first.

## Before you get started
Before you can get started with the cli tools you need to make sure you have the [Go programming language](https://golang.org/doc/install) and [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed. Go v1.11.x is required.
Before you can get started with the cli tools you need to make sure you have the [Go programming language](https://golang.org/doc/install) and [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed. Go v1.13.x is required.

> Don't forget to set your `GOPATH` variable and make sure that `$GOPATH/bin` is part of your `PATH`
>(see [here](https://golang.org/doc/code.html#GOPATH) or [here](https://github.com/golang/go/wiki/SettingGOPATH) for more details)
Expand All @@ -12,11 +12,11 @@ Before you can get started with the cli tools you need to make sure you have the
Copy and paste the following commands to install Project Dovetail™ commandline tool.

```
cd $GOPATH
curl https://github.com/TIBCOSoftware/dovetail-cli/releases/download/v0.1.3/dovetail-cli-install.sh -sSfL | sh
curl https://github.com/TIBCOSoftware/dovetail-cli/releases/download/v0.2.0/dovetail-cli-install.sh -sSfL v0.2.0 | sh
```

>The binary dovetail will be in the $GOPATH/bin directory.
>The binary dovetail will be in your dovetail-cli/bin directory.
>You can add /path/to/dovetail-cli/bin/dovetail to your PATH env variable for easier access.

## Installation Tutorial Video
Expand Down
8 changes: 4 additions & 4 deletions src/ch01-03-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ If you are developing for R3 Corda, following jars must be available in your loc
<dependency>
<groupId>com.tibco.dovetail</groupId>
<artifactId>dovetail-corda</artifactId>
<version>[0.1.3, )</version>
<version>[0.2.0, )</version>
</dependency>
```

> Project Dovetail™ library for R3 Corda is available [here](https://github.com/TIBCOSoftware/dovetail-contrib/releases/download/v0.1.3/dovetail_corda_v0.1.3.jar), run following command to install it to your local Maven repository
> Project Dovetail™ library for R3 Corda is available [here](https://github.com/TIBCOSoftware/dovetail-contrib/releases/download/v0.2.0/dovetail_corda_v0.2.0.jar), run following command to install it to your local Maven repository
```
mkdir dovetail_corda
cd dovetail_corda
curl -OL https://github.com/TIBCOSoftware/dovetail-contrib/releases/download/v0.1.3/dovetail_corda_v0.1.3.jar
mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -DgeneratePom=true -DgroupId=com.tibco.dovetail -DartifactId=dovetail-corda -Dversion=0.1.3 -Dfile=dovetail_corda_v0.1.3.jar -Dpackaging=jar
curl -OL https://github.com/TIBCOSoftware/dovetail-contrib/releases/download/v0.2.0/dovetail_corda_v0.2.0.jar
mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -DgeneratePom=true -DgroupId=com.tibco.dovetail -DartifactId=dovetail-corda -Dversion=0.2.0 -Dfile=dovetail_corda_v0.2.0.jar -Dpackaging=jar
```
6 changes: 6 additions & 0 deletions src/ch02-02-fabric-samples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## Fabric Samples and Tutorials

You can follow Hyperledger Fabric samples and tutorials in our [Dovetail Contrib](https://github.com/TIBCOSoftware/dovetail-contrib/tree/develop/hyperledger-fabric#getting-started) repository.



2 changes: 1 addition & 1 deletion src/ch02-06-generate-hf.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ For testing, transaction security support is not enabled.

```bash
cd iou_tutorial
dovetail contract generate -b fabric -m artifacts/IOU.json -v 1.0.0 -t artifacts/hlf
dovetail fabric contract generate -m artifacts/IOU.json -v 1.0.0 -t artifacts/hlf
```
2 changes: 1 addition & 1 deletion src/ch02-08-generate-corda.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Run following command from iou_tutorial directory, R3 Corda contract is written

```
cd iou_tutorial
dovetail contract generate -b corda -m artifacts/IOU.json -v 1.0.0 -t artifacts/corda --namespace com.example.iou
dovetail corda contract generate -m artifacts/IOU.json -v 1.0.0 -t artifacts/corda --namespace com.example.iou
```
10 changes: 5 additions & 5 deletions src/ch02-09-01-cordapp-gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ CorDapp responder flows have compile and runtime dependency on their correspondi
run following command from iou_tutorial folder

```bash
dovetail dapp generate -b corda -m artifiacts/charlie.json -v 1.0.0 -t artifacts/corda/charlie --namespace com.charlie.iou.flows --api
dovetail fabric dapp generate -m artifacts/charlie.json -v 1.0.0 -t artifacts/corda/charlie --namespace com.charlie.iou.flows --api

dovetail dapp generate -b corda -m artifacts/alice.json -v 1.0.0 -t artifacts/corda/alice --namespace com.alice.iou.flows --api
dovetail fabric dapp generate -m artifacts/alice.json -v 1.0.0 -t artifacts/corda/alice --namespace com.alice.iou.flows --api
```
### 6.4.3. Create dependency pom file for each organization

Expand Down Expand Up @@ -66,9 +66,9 @@ copy following to artifacts/bob.pom file
run following command from iou_tutorial folder

```bash
dovetail dapp generate -b corda -m artifacts/charlie.json -v 1.0.0 -t artifacts/corda/charlie --namespace com.charlie.iou.flows --dependency-file artifacts/charlie.pom
dovetail fabric dapp generate -m artifacts/charlie.json -v 1.0.0 -t artifacts/corda/charlie --namespace com.charlie.iou.flows --dependency-file artifacts/charlie.pom

dovetail dapp generate -b corda -m artifacts/alice.json -v 1.0.0 -t artifacts/corda/alice --namespace com.alice.iou.flows --dependency-file alice.pom
dovetail fabric dapp generate -m artifacts/alice.json -v 1.0.0 -t artifacts/corda/alice --namespace com.alice.iou.flows --dependency-file alice.pom

dovetail dapp generate -b corda -m artifacts/bob.json -v 1.0.0 -t corda/bob --namespace com.bob.iou.flows --dependency-file bob.pom
dovetail fabric dapp generate -m artifacts/bob.json -v 1.0.0 -t corda/bob --namespace com.bob.iou.flows --dependency-file bob.pom
```

0 comments on commit 95a86ab

Please sign in to comment.