improbable-eng/Dragoman

Name: Dragoman

Owner: Improbable Engineering

Description: GUI for polyglot

Created: 2017-08-07 14:43:51.0

Updated: 2018-05-20 00:34:55.0

Pushed: 2017-09-21 21:06:42.0

Homepage: null

Size: 71236

Language: TypeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Dragoman

An open source GUI for polyglot, a universal gRPC client

Dragoman

This is an open source project to allow easy debugging of gRPC services, and leverages polyglot. It is powered by Electron, react, redux, webpack

Getting Started

Prerequisites

• Polyglot requires java runtime 1.8.
• node >= 8.x
• npm >= 3.x

Installing

• Download the latest version from the releases tab.
• Alternatively clone this repo, run `npm run start`
• If you have no polyglot experience/setup consider reading through this readme.
• If you have used polyglot before you likely used a configuration file to persist settings, by default polylgot looks to ~/.polyglot/config.json.
• An example config might be (remember to insert the OAuth secret, path to refresh token, and update the proto discovery path and protoc include paths as appropriate):

  
  figurations": [
  
  ame": "production",
  all_config": {
  "use_tls": "true",
  "oauth_config": {
    "refresh_token_credentials": {
      "token_endpoint_url": "https://my.auth.server/auth/v1/token",
      "client": {
        "id": "my_client_id",
        "secret": "{{INSERT CLIENT SECRET HERE}}"
      },
      "refresh_token_path": "{{INSERT PATH TO REFRESH TOKEN HERE}}"
    }
  }
  
  roto_config": {
  "proto_discovery_root": "/path/to/protos",
  "include_paths": [
    "path/to/protoc/include/1",
    "path/to/protoc/include/2"
  ]
  
  
  
  
  

Known Issues

• Polyglot is known to hang if authentication fails, causing the request to hang indefinitely. Cancel the request, get a new refresh token and try again.
• Difficult to read service/method name

Development

To get started clone the repo:

clone https://github.com/improbable-eng/Dragoman.git your-project-name

And then install dependencies.

 your-project-name && npm install

Run

Run these two commands simultaneously in different console tabs for hot module replacement.

m run hot-server
m run start-hot

To simply get going run:

m run start

DevTools

Toggle Chrome DevTools

• OS X: Cmd Alt I or F12
• Linux: Ctrl Shift I or F12
• Windows: Ctrl Shift I or F12

See electron-debug for more information.

DevTools extension

This boilerplate is included following DevTools extensions:

• Devtron - Install via electron-debug.
• React Developer Tools - Install via electron-devtools-installer.
• Redux DevTools - Install via electron-devtools-installer.

You can find the tabs on Chrome DevTools.

If you want to update extension versions, please set UPGRADE_EXTENSIONS env, just run:

r macOS
GRADE_EXTENSIONS=1 npm run dev

r Windows
t UPGRADE_EXTENSIONS=1 && npm run dev

Packaging

To package apps for the local platform:

m run package

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

Then,

m run package-all

To package apps with options:

m run package -- --[option]

Further commands

To run the application without packaging run

m run start

To run End-to-End Test

m run build
m run test-e2e