Skip to content

Commit

Permalink
Updated the docs for the storage example
Browse files Browse the repository at this point in the history
  • Loading branch information
meling committed Mar 27, 2021
1 parent e7ae2b8 commit cc11cf9
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
34 changes: 19 additions & 15 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,34 @@
# Gorums examples

This folder contains examples of services implemented with Gorums.
If you want a detailed walkthrough of how to get started with Gorums, read the [user guide](../doc/userguide.md).

## Prerequisites

Requires Go 1.13 or later and you must have `$GOPATH/bin` in your `$PATH`.
See <https://github.com/golang/go/wiki/SettingGOPATH> for more details.
If you want a detailed walkthrough of how to get started with Gorums, read the [user guide](../doc/user-guide.md).

## Interactive Storage service

The `storage` example implements a simple key-value storage service.
The client features an interactive command line interface that allows you to send RPCs and quorum calls to different configurations of servers, called Nodes.
The client features an interactive command line interface that allows you to send RPCs and quorum calls to different configurations of servers, called nodes.
Both the client and the server are included in the same binary, and four local servers will be started automatically.

Install:
To install:

```shell
make
```

`go get github.com/relab/gorums/examples/storage`
Optionally:

Run:
```shell
go build -o ./storage ./storage
```

`storage`
To run:

## (Optional) Compile examples with Make
```shell
./storage/storage
```

Run `make` in this folder to compile all examples.
Requires a recent `protoc` version 3.
To recompile the proto files:

If you need to recompile the proto files, you can run `make -B`.
```shell
make -B
```
3 changes: 2 additions & 1 deletion gorums.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
"qspec",
"relab",
"shlex",
"timestamppb"
"timestamppb",
"walkthrough"
]
}
}

0 comments on commit cc11cf9

Please sign in to comment.