monorepo: merge 'kurento-tutorial-node' into tutorials/javascript-node/

Kurento · Jan 17, 2023 · 10ad854 · 10ad854
2 parents 1aecae4 + c842ff2
commit 10ad854
Show file tree

Hide file tree

Showing 157 changed files with 9,205 additions and 0 deletions.
diff --git a/tutorials/javascript-node/.gitignore b/tutorials/javascript-node/.gitignore
@@ -0,0 +1,11 @@
+.classpath
+.project
+.settings/
+.jshintrc
+node_modules/
+bower_components/
+package-lock.json
+*~
+.DS_Store
+npm-debug.log
+*reports
diff --git a/tutorials/javascript-node/README.md b/tutorials/javascript-node/README.md
@@ -0,0 +1,186 @@
+[![License badge](https://img.shields.io/badge/license-Apache2-orange.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+[![Documentation badge](https://readthedocs.org/projects/fiware-orion/badge/?version=latest)](http://doc-kurento.readthedocs.org/en/latest/)
+[![Docker badge](https://img.shields.io/docker/pulls/fiware/orion.svg)](https://hub.docker.com/r/fiware/stream-oriented-kurento/)
+[![Support badge]( https://img.shields.io/badge/support-sof-yellowgreen.svg)](http://stackoverflow.com/questions/tagged/kurento)
+
+[![][KurentoImage]][Kurento]
+
+Copyright © 2013-2016 [Kurento]. Licensed under [Apache 2.0 License].
+
+Kurento tutorial for Node.js
+============================
+Examples on usage of the Kurento Node.js Client.
+
+This project contains a set of simple applications built with JavaScript Kurento
+Client APIs ([kurento-client-js] and [kurento-utils-js]) for [Node.js].
+
+The source code of this project can be cloned from the [GitHub repository].
+
+Installation instructions
+-------------------------
+
+Be sure to have installed [Node.js] in your system:
+
+```bash
+curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
+sudo apt-get install -y nodejs
+```
+
+It is recommended to update NPM to the latest version:
+
+```bash
+sudo npm install npm -g
+```
+
+
+Install node modules and bower components
+
+```bash
+npm install
+```
+
+Run the application and have fun ...
+
+```bash
+npm start
+```
+
+Parameters
+----------
+
+The Node.js server accept an optional parameter with the URI of the MediaServer
+WebSocket endpoint, being set by default at ws://localhost:8888/kurento. You can
+define its value by using the ```ws_uri``` flag:
+
+```bash
+npm start -- --ws_uri=ws://example.com:8888/kurento
+```
+
+It also accept an optional parameter with the URI of the application server root
+that will serve the overlay image, being by default at https://localhost:8443/.
+You can define its value by using the ```as_uri``` flag:
+
+```bash
+npm start -- --as_uri=https://example.org:8443/
+```
+
+For example, if you would like to start the node server in the localhost using
+the port 8081, then the command is the following:
+
+```bash
+npm start -- --as_uri=https://localhost:8081/
+```
+
+Please notice that the double dash separator (```--```) is [on
+purpose](https://www.npmjs.org/doc/cli/npm-run-script.html#description).
+
+
+Kurento
+=======
+
+What is Kurento
+---------------
+
+Kurento is an open source software project providing a platform suitable
+for creating modular applications with advanced real-time communication
+capabilities. For knowing more about Kurento, please visit the Kurento
+project website: https://kurento.openvidu.io/.
+
+Kurento is part of [FIWARE]. For further information on the relationship of
+FIWARE and Kurento check the [Kurento FIWARE Catalog Entry]
+
+Kurento is part of the [NUBOMEDIA] research initiative.
+
+Documentation
+-------------
+
+The Kurento project provides detailed [documentation] including tutorials,
+installation and development guides. A simplified version of the documentation
+can be found on [readthedocs.org]. The [Open API specification] a.k.a. Kurento
+Protocol is also available on [apiary.io].
+
+Source
+------
+
+Code for other Kurento projects can be found in the [GitHub Kurento Group].
+
+News and Website
+----------------
+
+Check the [Kurento blog]
+Follow us on Twitter @[kurentoms].
+
+Issue tracker
+-------------
+
+Issues and bug reports should be posted to the [GitHub Kurento bugtracker]
+
+Licensing and distribution
+--------------------------
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Contribution policy
+-------------------
+
+You can contribute to the Kurento community through bug-reports, bug-fixes, new
+code or new documentation. For contributing to the Kurento community, drop a
+post to the [Kurento Public Mailing List] providing full information about your
+contribution and its value. In your contributions, you must comply with the
+following guidelines
+
+* You must specify the specific contents of your contribution either through a
+  detailed bug description, through a pull-request or through a patch.
+* You must specify the licensing restrictions of the code you contribute.
+* For newly created code to be incorporated in the Kurento code-base, you must
+  accept Kurento to own the code copyright, so that its open source nature is
+  guaranteed.
+* You must justify appropriately the need and value of your contribution. The
+  Kurento project has no obligations in relation to accepting contributions
+  from third parties.
+* The Kurento project leaders have the right of asking for further
+  explanations, tests or validations of any code contributed to the community
+  before it being incorporated into the Kurento code-base. You must be ready to
+  addressing all these kind of concerns before having your code approved.
+
+Support
+-------
+
+The Kurento project provides community support through the  [Kurento Public
+Mailing List] and through [StackOverflow] using the tags *kurento* and
+*fiware-kurento*.
+
+Before asking for support, please read first the [Kurento Netiquette Guidelines]
+
+[documentation]: https://kurento.openvidu.io/documentation
+[FIWARE]: http://www.fiware.org
+[GitHub Kurento bugtracker]: https://github.com/Kurento/bugtracker/issues
+[GitHub Kurento Group]: https://github.com/kurento
+[kurentoms]: http://twitter.com/kurentoms
+[Kurento]: https://kurento.openvidu.io/
+[Kurento Blog]: https://kurento.openvidu.io/blog
+[Kurento FIWARE Catalog Entry]: http://catalogue.fiware.org/enablers/stream-oriented-kurento
+[Kurento Netiquette Guidelines]: https://kurento.openvidu.io/blog/kurento-netiquette-guidelines
+[Kurento Public Mailing list]: https://groups.google.com/forum/#!forum/kurento
+[KurentoImage]: https://secure.gravatar.com/avatar/21a2a12c56b2a91c8918d5779f1778bf?s=120
+[Apache 2.0 License]: http://www.apache.org/licenses/LICENSE-2.0
+[NUBOMEDIA]: http://www.nubomedia.eu
+[StackOverflow]: http://stackoverflow.com/search?q=kurento
+[Read-the-docs]: http://read-the-docs.readthedocs.org/
+[readthedocs.org]: http://kurento.readthedocs.org/
+[Open API specification]: http://kurento.github.io/doc-kurento/
+[apiary.io]: http://docs.streamoriented.apiary.io/
+[GitHub repository]: https://github.com/Kurento/kurento-tutorial-node
+[kurento-client-js]: https://github.com/Kurento/kurento-client-js
+[kurento-utils-js]: https://github.com/Kurento/kurento-utils-js
+[Node.js]: http://nodejs.org/