Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/treer00t/openrtp
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.
https://github.com/treer00t/openrtp
nodejs socket-io swagger
Last synced: 15 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/treer00t/openrtp
- Owner: TREER00T
- License: mit
- Created: 2022-08-11T15:02:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-26T18:28:37.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T17:16:38.429Z (about 1 month ago)
- Topics: nodejs, socket-io, swagger
- Language: JavaScript
- Homepage:
- Size: 595 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG/0.5.x/CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenRTP
## Table of Contents
- [Screenshots](#screenshots)
- [Install](#install)
- [Introduction](#introduction)
- [HowToUse](#howtouse)
- [Configuration](#configuration)
- [Documentation](#documentation)
- [ChangeLog](#changelog)
## Screenshots
[Click](https://github.com/treegex/openrtp/tree/main/screenshots) to see openRTP example screenshots
## Install
This is a [Node.js](https://nodejs.org/en/) module available through the
[npm registry](https://www.npmjs.com/).
Before installing, [download and install Node.js](https://nodejs.org/en/download/). Node.js 0.6 or higher is required.
Installation is done using the
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
```sh
$ 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:
```js
let openRTP = require('openrtp');
openRTP({
fileLocation: 'openrtp.yaml'
});
```
And run this command:
```shell
npm start
```
The port of server for listening event By default is 17892, you can actually Configuration
openRTP, [click](https://github.com/treegex/openrtp#Configuration) for more information
## Configuration
```js
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](https://github.com/treegex/openrtp/tree/main/docs/docs.md) for more information
## ChangeLog
#### Version 1.x
[Change Log](https://github.com/treegex/openrtp/tree/main/CHANGELOG/1.x/CHANGELOG.md)
#### Version 0.5.x
[Change Log](https://github.com/treegex/openrtp/tree/main/CHANGELOG/0.5.x/CHANGELOG.md)