openrtp
v1.0.7
Published
Is a text-based software framework supported by an extensive ecosystem of tools that help developers design, build, document, and use programming relationships for socket.io.
Downloads
25
Maintainers
Readme
OpenRTP
Table of Contents
Screenshots
Click to see openRTP example screenshots
Install
This is a Node.js module available through the npm registry.
Before installing, download and install Node.js. Node.js 0.6 or higher is required.
Installation is done using the
npm install
command:
$ npm i openrtp
Introduction
Is a text-based software framework supported by an extensive ecosystem of tools that help developers design, build, document, and use programming relationships for socket.io.
HowToUse
Write this code in js file:
let openRTP = require('openrtp');
openRTP({
fileLocation: 'openrtp.yaml'
});
And run this command:
npm start
The port of server for listening event By default is 17892, you can actually Configuration openRTP, click for more information
Configuration
let openRTP = require('openrtp');
openRTP({
fileLocation: 'openrtp.yaml',
host: '127.0.0.1',
port: '3000',
route: '/io/docs'
});
fileLocation
=> Yaml file path
port
=> OpenRTP express port
host
=> OpenRTP express host
route
=> Is the path to display the output of the yaml file in the rest api
Documentation
It gives you information about the yaml file structure, click for more information