nazosnare/vupc

WebRTC screensharing

VUPC

WebRTC screensharing Electron app for all desktop platforms

Table of contents

• General info
• Screenshots
• Technologies
• Setup
• Features
• Status
• Inspiration
• Contact

General info

VUPC is an open source screen sharing + remote collaboration application for Mac OS, Linux, Windows. You can share your desktop with someone else while letting them share your mouse and keyboard remotely. Right now it is not as good as commercial alternatives, mostly because this initial prototype was written in 3 days. The big difference is that you can send PRs to make VUPC better

Screenshots

Demo

You can download the demo application which may not be up to date with the latest changes in master. This application uses our server for signaling.

• MacOS
• Linux

Technologies

• Electron - version 9.0
• VueJS - version 2.6
• NodeJS - version 13.9

Setup

You can download the binaries already compiled, or you can compile a local version yourself.

Building the app

 Requirements

• Common - NodeJS & Yarn
• MacOS - XCode
• Windows - Microsoft visual studio build tools 2017
• Linux - libxtst & libpng sudo apt-get install libxtst-dev libpng++-dev

Clone repository : git clone [email protected]:machester4/vupc.git

Install server dependencies :

cd server && yarn

Install app dependencies :

cd app && yarn

run server :

cd server && yarn run start:debug

run app :

cd app && yarn run electron:serve

Features

List of features ready and TODOs for future development

• Share screen
• Mouse click event in host

  To-do list:

• Keyboard events in host
• Your ideas :)

Status

VUPC is currently ALPHA STATUS and is intended for developers/early adopters. Check out the Issues to get involved. VUPC is a volunteer run project, your contributions and improvements are welcome!

Inspiration

This project is inspired by ScreenCat which was discontinued a long time ago.

Contact

Created by @machester4 (Michael Pintos) - feel free to contact me!

MIT License