Name: kurento-client-js
Owner: Vivocha
Description: null
Forked from: Kurento/kurento-client-js
Created: 2016-12-07 15:35:02.0
Updated: 2016-12-07 15:35:03.0
Pushed: 2016-12-05 15:51:08.0
Size: 1074
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Copyright © 2013-2016 Kurento. Licensed under Apache 2.0 License.
The project contains the implementation of the JavaScript Kurento Client for web applications and Node.js.
The source code of this project can be cloned from the GitHub repository.
These instructions are intended for code contributors or people willing to compile the browser version themselves. If you are a browser-only developer, it's better that you have a look at the JavaScript Kurento Client for Bower instructions.
Be sure to have installed Node.js in your system:
-sL https://deb.nodesource.com/setup_4.x | sudo bash -
apt-get install -y nodejs
To install the library, it's recommended to do that from the NPM repository :
install kurento-client
Alternatively, or if you want to modify the JavaScript Kurento Client code or generate yourself the browser version of the library, you can download the development code files using git and install manually its dependencies:
clone https://github.com/Kurento/kurento-client-js
urento-client-js
install
In this last case, you will also need to have installed Kurento Module Creator so you can be able to generate the client libraries code.
To build the browser version of the library, after downloading the development
code files, you'll only need to exec the grunt task runner from the root of
the project and they will be generated on the `dist` folder. Alternatively,
if you don't have it globally installed, you can run a local copy by executing
_modules/.bin/grunt
Tests are autonomous and based on QUnit testing framework. Their only
requirement is to exec previously `npm install` to have installed all the
dev dependencies.
After building the web browser version of the library, just open the file
ase of the browser raise some security policy errors, you can host the tests
by running any static web server at the source code root folder, for
ple by launching the command
python -m SimpleHTTPServer 8000
can be able to configure to what WebSocket endpoint you want to connect on
dropdown list at the top of the tests page.
Node.js
xec test in Node.js, you only need to exec ```npm test```, that will launch
the tests automatically using [QUnit-cli].
his moment, the default WebSocket endpoint can not be changed due to limits
he current implementation of NPM. If you need to use a different WebSocket
oint from the default one, you can exec the underlying test command and
nd a *ws_uri* parameter pointing to the alternative WebSocket endpoint:
node_modules/.bin/qunit-cli -c kurentoClient:. -c wock:node_modules/wock -c test/common.js -c test/proxy.js test/*.js –ws_uri=ws://localhost:8080
nto
===
is Kurento
-----------
nto is an open source software project providing a platform suitable
creating modular applications with advanced real-time communication
bilities. For knowing more about Kurento, please visit the Kurento
ect website: http://www.kurento.org.
nto is part of [FIWARE]. For further information on the relationship of
RE and Kurento check the [Kurento FIWARE Catalog Entry]
nto is part of the [NUBOMEDIA] research initiative.
mentation
---------
Kurento project provides detailed [documentation] including tutorials,
allation and development guides. A simplified version of the documentation
be found on [readthedocs.org]. The [Open API specification] a.k.a. Kurento
ocol is also available on [apiary.io].
ce
--
for other Kurento projects can be found in the [GitHub Kurento Group].
and Website
------------
k the [Kurento blog]
ow us on Twitter @[kurentoms].
e tracker
---------
es and bug reports should be posted to the [GitHub Kurento bugtracker]
nsing and distribution
----------------------
nsed under the Apache License, Version 2.0 (the "License");
may not use this file except in compliance with the License.
may obtain a copy of the License at
tp://www.apache.org/licenses/LICENSE-2.0
ss required by applicable law or agreed to in writing, software
ributed under the License is distributed on an "AS IS" BASIS,
OUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
the License for the specific language governing permissions and
tations under the License.
ribution policy
---------------
can contribute to the Kurento community through bug-reports, bug-fixes, new
or new documentation. For contributing to the Kurento community, drop a
to the [Kurento Public Mailing List] providing full information about your
ribution and its value. In your contributions, you must comply with the
owing guidelines
u must specify the specific contents of your contribution either through a
tailed bug description, through a pull-request or through a patch.
u must specify the licensing restrictions of the code you contribute.
r newly created code to be incorporated in the Kurento code-base, you must
cept Kurento to own the code copyright, so that its open source nature is
aranteed.
u must justify appropriately the need and value of your contribution. The
rento project has no obligations in relation to accepting contributions
om third parties.
e Kurento project leaders have the right of asking for further
planations, tests or validations of any code contributed to the community
fore it being incorporated into the Kurento code-base. You must be ready to
dressing all these kind of concerns before having your code approved.
ort
---
Kurento project provides community support through the [Kurento Public
ing List] and through [StackOverflow] using the tags *kurento* and
are-kurento*.
re asking for support, please read first the [Kurento Netiquette Guidelines]