Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ulises-jeremias/grpc-research-pdytr


https://github.com/ulises-jeremias/grpc-research-pdytr

Last synced: 20 days ago
JSON representation

Awesome Lists containing this project

README

        

# gRPC-research-pdytr

[![Tests Status][workflowbadge]][workflowurl]
[![License: MIT][licensebadge]][licenseurl]

- [gRPC-research-pdytr](#grpc-research-pdytr)
- [gRPC](#grpc)
- [Quickstart](#quickstart)
- [Simple example](#simple-example)
- [RPC](#rpc)
- [Quickstart](#quickstart-1)
- [Simple example](#simple-example-1)
- [Tests](#tests)

## gRPC

### Quickstart

We provide a docker environment to execute the different applications. To start the docker container execute the following command,

```sh
$ ./bin/grpc --app= [--build] [--root]
```

where,

```
= simp | ftp | user_lookup | request_stream | response_stream | request_and_response_stream
```

_NOTE: Execute `./bin/grpc -h` to know more about flags._

This will execute a docker container in interactive mode with a volume in the directory of the application.



Once the docker container is running you will be able to run the following examples!

### Simple example

```sh
# generate proto file
~> protoc --go_out=plugins=grpc:. ./.proto

# execute server in background
~> go run ./server/main.go &

# execute client
~> go run ./client/main.go
```

## RPC

### Quickstart

We provide a docker environment to execute the different applications. To start the docker container execute the following command,

```sh
$ ./bin/rpc --app= [--build] [--root]
```

where,

```
= simp | ftp | user_lookup | ...
```

_NOTE: Execute `./bin/rpc -h` to know more about flags._

This will execute a docker container in interactive mode with a volume in the directory of the application.

Once the docker container is running you will be able to run the following examples!

### Simple example

```sh
# build binaries
~> make

# execute server in background
~> ./server &

# execute client
~> ./client
```

## Tests

You can run all tests executing the following command:

```sh
$ ./bin/test
```

These tests are already executed on every commit to master on Github Actions. You can check the workflows and download the performance tests results.

[workflowbadge]: https://github.com/ulises-jeremias/gRPC-research-pdytr/actions/workflows/ci.yml/badge.svg
[licensebadge]: https://img.shields.io/badge/License-MIT-blue.svg
[workflowurl]: https://github.com/ulises-jeremias/gRPC-research-pdytr/actions/workflows/ci.yml
[licenseurl]: https://github.com/ulises-jeremias/gRPC-research-pdytr/blob/master/LICENSE