From 444bdbd401c94b030f11f5e47cb5d282618d86f8 Mon Sep 17 00:00:00 2001 From: Zachary Belford Date: Sat, 6 Apr 2019 13:47:55 -0700 Subject: [PATCH] feat(init): add init step --- README.md | 44 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 209253af..8dc07d8b 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,44 @@ Inspired by [mole-rpc](https://github.com/koorchik/node-mole-rpc), built for Ope npm install -g @open-rpc/server-js ``` -#### Setup handlers for AutoRouter +#### Init ```bash -mkdir ./method-handlers -echo "export default (a, b) => a - b;" > ./method-handlers/subtraction.js -echo "export default (a, b) => a + b;" > ./method-handlers/addition.js +$ open-rpc-server-js init + +$ cat open-rpc-server.json +{ + "transports": [ + "HTTPServerTransportOptions", + "HTTPSServerTransportOptions", + "WebSocketServerTransportOptions", + "IPCServerTranportOptions" + ], + "transportOptions": { + "HTTPServerTransportOptions": { "port": 8080 } + "HTTPSServerTransportOptions": { "port": 8081 } + "WebSocketServerTransportOptions": { "port": 8082 }, + "IPCServerTranportOptions": { "port": 8083 } + } +} +``` + +#### Generate new api version scaffolding + +```bash +$ open-rpc-server-js \ + -g \ + -s https://raw.githubusercontent.com/open-rpc/examples/master/service-descriptions/simple-math-openrpc.json +Server project initialized! + +$ ls ./method-handlers +1.0.0 + +$ ls ./method-handlers/1.0.0 +addition.js subtraction.ts + +$ cat ./method-handlers/1.0.0/addition.js +export default (a: number, b: number): Promise => {} ``` #### Setup simple confg file @@ -48,12 +80,14 @@ open-rpc-server-js \ Thats it! +--- + ### Javascript/Typescript API #### Install ```bash -npm install -g @open-rpc/server-node +npm install --save @open-rpc/server-node ``` #### Creating Routers