WebRTC Signaling Service

Simple STUN service for the WebRTC parts of slidewiki-platform and also for the reveal multiplexing plugin.

Install NodeJS

---

Please visit the wiki at Install NodeJS.

Where to start developing?

---

Have a look at the file application/server.js, that is the main routine of this service. Follow the require(...) statements to get trough the entire code in the right order.

When you want to have a look at tests, head over to the folder application/tests/. We're using Mocha and Chai for our purposes.

Since we're developing our application with NodeJS, we're using npm as a task runner. Have a look at the /application/package.json script section to obtain an overview of available commands. Some are:

# Run syntax check and lint your code
npm run lint

# Run unit tests
npm run unit:test

# Start the application
npm start
...

Use Docker to run/test your application

---

You can use Docker to build, test and run your application locally. Simply edit the Dockerfile and run:

docker build -t MY_IMAGE_TAG ./
docker run -it --rm -p 8880:3000 MY_IMAGE_TAG

Alternatively you can use docker-compose to run your application in conjunction with a (local) mongodb instance. Simply execute:

docker-compose up -d