Git Product home page Git Product logo

openrtp's Introduction

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

ChangeLog

Version 1.x

Change Log

Version 0.5.x

Change Log

openrtp's People

Contributors

treer00t avatar

Stargazers

 avatar shravan || श्रvan avatar

Watchers

Kostas Georgiou avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.