francoisp/deskreen

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

Deskreen

Website: https://www.deskreen.com

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

yarn test -- run client tests in watch mode test:nowatch -- run client tests a single time yarn test -- -u -- update snapshots

Generate test coverage results

yarn coverage -- when run from project root, generates a coverage report for host and app/client

Instruction for running a local Sonar Qube, community edition

Prerequisites

You need to install Sonar Qube community edition for your machine. And sonar-scanner. Then add sonar scanner to your PATH.

You need to run sonar-scanner separately on root directory and on app/client directory.

Luckily for you sonar scanner is automatically triggered after husky checks. So you only need to install and configure SonarCube locally and create two separate projects in SonarCube panel. First project for host app, and second project for client viewer app. TODO: add how to get started with local SonarCube for Deskreen in details.

Note on versioning:

• All versions git tags should start with v ex. v1.0.0
• Before making a new release with git push <version-tagname> set version to <version-tagname> ! without v in the beginning! (ex. 1.0.0 -- not start with v) in these three files:
  • package.json -- in version key ex. 1.0.0
  • app/package.json -- in version key ex. 1.0.0
  • app/package-lock.json -- in version key ex. 1.0.0

Maintainer

• Pavlo (Paul) Buidenkov

License

AGPL-3.0 License © Pavlo (Paul) Buidenkov

Copyright

Deskreen Logo PNG Image -- © Nadiia Plaunova

Apache 2.0 © blueprintjs

MIT © Electron React Boilerplate

Donate

Click to donate on Deskreen's Patreon page: DONATE!