Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 29 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,36 +19,52 @@ Visit [SUPPORTED_FEATURES.md](SUPPORTED_FEATURES.md) to see the full list of fea

[>>> Watch the demo <<<](https://www.youtube.com/watch?v=5yn3_g6Cybw)

## Quick start

```bash
curl fablo.io/install.sh | bash
./fablo init node rest
./fablo up
```

This will create a local Hyperledger Fabric network with a sample Node.js chaincode (using the `node` parameter) and a REST API client (using the `rest` parameter).
After a few minutes, the entire network will be set up and running.

You can check the running nodes using `docker ps` or `docker stats`. You can also query the network via the command line (`fablo chaincode invoke` or `fablo chaincode query`), use the REST API client (see [Fablo REST](https://github.com/fablo-io/fablo-rest)), or view the network topology in the `fablo-target/network-topology.mmd` Mermaid diagram.

## Installation

Fablo is distributed as a single shell script that uses a Docker image to generate the network configuration.
You can keep the script in the root directory of your project or install it globally on your system.

To get a copy of Fablo for a single project, run this command in your project root:
To install it locally in your project directory:

```bash
curl -Lf https://github.com/hyperledger-labs/fablo/releases/download/2.4.3/fablo.sh -o ./fablo && chmod +x ./fablo
curl fablo.io/install.sh | bash
# OR
curl fablo.io/fablo.sh > fablo && chmod +x fablo
```

To install it globally, run:
To install it globally on your system:

```bash
sudo curl -Lf https://github.com/hyperledger-labs/fablo/releases/download/2.4.3/fablo.sh -o /usr/local/bin/fablo && sudo chmod +x /usr/local/bin/fablo
sudo curl fablo.io/fablo.sh -o /usr/local/bin/fablo && sudo chmod +x /usr/local/bin/fablo
```

## Getting started
To install a given version use:

```bash
curl https://github.com/hyperledger-labs/fablo/releases/download/<version>/fablo.sh
```

To create a local Hyperledger Fabric network with Node.js chaincode and REST API client, install Fablo and run:
To change version of current installation:

```bash
fablo init node rest
fablo up
fablo use <version>
```

Note: For local setup use `./fablo` instead of `fablo`.
Note: If you install Fablo as a local script, you call it as `./fablo <command>`.
If you install it globally, you call `fablo <command>`.
For the simplicity we will refer to it as `fablo`.

After a few minutes, the entire network will be set up and running.
You can check the running nodes using `docker ps` or `docker stats`, and query the network via command line (`fablo chaincode invoke|query`) or REST API client (via [Fablo REST](https://github.com/fablo-io/fablo-rest)).

## Basic usage

Expand Down
Loading
Loading