starpc 0.0.1

package/README.md

@@ -0,0 +1,56 @@
+# Stream RPC (starpc)
+
+**starpc** is a Protobuf RPC implementation leveraging an external Stream
+multiplexer and Message framing system like HTTP/2 or Yamux.
+
+Uses any two-way ordered message channel like WebSocket or BroadcastChannel.
+
+Implementation features:
+
+ - Generates a Go server for proto3 services that does not use reflection.
+ - Uses the **ts-proto** RPC interface to implement TypeScript clients.
+ - Each RPC call is mapped to a Stream preventing head-of-line blocking.
+
+The Go backend provides an interface for forwarding the incoming RPC calls to
+the appropriate backend service.
+
+# Usage
+
+## Go
+
+TODO
+
+Copy the Go project boilerplate files:
+
+ - Makefile: implements "make gengo" to generate Go code with protoc.
+ - hack/: downloads & builds the necessary protoc-gen-go tools.
+
+To generate code for .proto files in your repository:
+
+ - `git add .` - stage all changes first.
+ - `make gengo` - generate the protobuf files.
+
+Example of creating & serving a service in Go: (TODO)
+
+## TypeScript
+
+See the ts-proto README to generate the TypeScript for your protobufs.
+
+```typescript
+import { RpcClient, WebSocketConn } from 'starpc'
+import { DemoServiceClientImpl } from './demo'
+
+const ws = new WebSocket('ws://localhost:5000/demo')
+const channel = new WebSocketConn(ws)
+const rpc = new RpcClient(channel)
+const demoServiceClient = new DemoServiceClientImpl(rpc)
+
+const result = await demoServiceClient.DemoEcho({
+  msg: "Hello world!"
+})
+console.log('output', result.msg)
+```
+
+`WebSocketConn` uses [js-libp2p-mplex] to multiplex streams over the WebSocket.
+
+[js-libp2p-mplex]: https://github.com/libp2p/js-libp2p-mplex

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "starpc",
+  "version": "0.0.1",
+  "description": "Streaming protobuf RPC service protocol over any two-way channel.",
+  "repository": "github:paralin/starpc",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Christian Stewart",
+    "email": "christian@aperture.us",
+    "url": "http://github.com/paralin"
+  },
+  "scripts": {},
+  "prettier": {},
+  "dependencies": {}
+}