Skip to content

Commit

Permalink
First commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
willemdj committed Jun 15, 2017
1 parent 643ef2d commit 7159abe
Show file tree
Hide file tree
Showing 43 changed files with 11,803 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
PROJECT = grpc
PROJECT_DESCRIPTION = gRPC in Erlang
PROJECT_VERSION = 0.1.0

# Whitespace to be used when creating files from templates.
SP = 4

DEPS = gpb cowboy chatterbox
dep_cowboy = git https://github.com/willemdj/cowboy
dep_chatterbox = git https://github.com/willemdj/chatterbox
include erlang.mk
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# gRPC

An implementation of gRPC in Erlang.

## Build
gRPC uses [erlang.mk](https://erlang.mk/) as build tool. On Unix systems it can be built
with:

```
make
```

`make doc` can be used to generate documentation for the individual
modules from edoc comments in thos modules.

See the [erlang.mk documentation](https://erlang.mk/guide/installation.html#_on_windows) for
an explanation on how the tool can be used in a Windows environment.

## Testing
`make ct` can be used to run a number of tests.

In the test directory there is an explanation how the software can be
tested against the go grpc implementation.

## Dependencies

- [gpb](https://github.com/tomas-abrahamsson/gpb) is used to encode and
decode the protobuf messages.

- [cowboy](https://github.com/willemdj/cowboy) is used for the server.
This is a fork with some changes to the support for HTTP/2.

- [chatterbox](https://github.com/willemdj/chatterbox) is used for the
client. This is also a fork with a couple of modifications related to missing
HTTP/2 features.

## gRPC functionality

[tutorial](/doc/tutorial.md)
1 change: 1 addition & 0 deletions doc/overview.edoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@title grpc - an Erlang implementation of gRPC
Loading

0 comments on commit 7159abe

Please sign in to comment.