{"repo":"Nexmo/nexmo-oas-renderer","free":true,"listed":false,"github":"https://github.com/Nexmo/nexmo-oas-renderer","clone":"git clone https://github.com/Nexmo/nexmo-oas-renderer.git","description":"Render your API references, Nexmo-style!","language":"HTML","stars":45,"topics":["ruby-on-rails","openapi","documentation","nexmo","tools","oas3","developer-destination","openapi3"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Nexmo OAS Renderer Sinatra application that provides a preview of how the OAS documents will be rendered within Nexmo Developer. Dependencies Installation and Usage Using Docker As a standalone application Mounted into a Rails application Specifying the path to the documents Contributing License Dependencies Installation and Usage Using Docker You can run using Docker and it will serve the current directory (this will usually be the api-specification repo): Mac/Linux Alternatively, add the following to your /.bashrc file and you'll be able to run nexmo-oas-renderer Windows As a standalone application Install the gem: And simply run the executable with the corresponding env variables set (see Note): Or, if you want to make code changes, just run the following command which will start the web server on http://localhost:9393: Mounted into a Rails Application Add this to your application's Gemfile : And then run bundle install . Require the gem in config/environment.rb as follows: And finally mount the Sinatra app into your Rails application by adding the following line to config/routes.rb : Specifying the path to the documents This gem uses dotenv to handle environment variables, so you should copy the .env.example provided by running: and assign values to the corresponding variables. Note The env variable OAS PATH indicates the path to the documents that will be rendered. Contributing We ❤️ contributions from everyone! Bug reports, bug fixes and feedback on the library is alway","default_branch":null,"files":null,"tree":[],"storefront":"/r/Nexmo","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Nexmo/nexmo-oas-renderer/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}