protodoc-server

1.1.0 • Public • Published

protodoc-server

Overview

  • Protobuf auto documentation generator + documentation ECS hosting command
  • Inspired by [glennjones/hapi-swagger](https://github.com/glennjones/hapi-swagger)

Prerequisits

  • Make your protofiles on ./proto dir
  • Convox registration and Amazon ECS setting

Run locally

  • protodoc-server start

Run publicly

  • protodoc-server deploy

Route

  • /documentation

FYI

  • Convox is AmazonECS wrapper, same like kubernetes
  • Dockerfile and docker-componse.yml is on npm repository
  • You need to ready /proto and convox for deployment

Future work

  • Faster deployment. Now 5m20s needed

Readme

Keywords

none

Package Sidebar

Install

npm i protodoc-server

Weekly Downloads

10

Version

1.1.0

License

MIT

Last publish

Collaborators

  • shogochiai