Skip to content
/ deskreen Public
forked from pavlobu/deskreen

Deskreen turns any device with a web browser to a second screen for your computer

License

Notifications You must be signed in to change notification settings

lrvl/deskreen

 
 

Repository files navigation

Deskreen

Deskreen Logo

Deskreen turns any device with a web browser to a second screen for your computer

Deskreen is an electron.js based application that uses WebRTC to make a live stream of your desktop to a web browser on any device. It is built on top of Electron React Boilerplate For better security mechanism, end-to-end encrytpion is implemented, which is inspired by darkwire.io , the difference is, that it is rewritten in Typescript and trnasformed to use node-forge instead of window.crypto.subtle. Why this was made? Because a client served with http without SSL, which makes window.crypto. subtle unavailable. (TODO: write more docs about Deskreen architecture)

Get Started for Developers

Prerequisites

You will need to have node npm and yarn installed globally on your machine.

  1. git clone this repo
  2. yarn install
  3. yarn dev -- run in dev mode with live updates

Useful yarn commands

yarn start -- run in production mode to test, without packaging yarn package -- to package an app and make executables available in release folder

for more yarn commands look at package.json

How to run tests

yarn test -- run all unit tests yarn build-ux && yarn test-ux -- run User Experience tests (no tests for app/client yet)

TODO: add e2e tests with host + client app interaction

run tests of host app

yarn test-watch-not-silent -- run tests in watch mode with console logs only for host app, excluding app/client yarn test -- -u -- update snapshots

run tests for app/client