GithubHelp home page GithubHelp logo

thomscoder / orchestra Goto Github PK

View Code? Open in Web Editor NEW
2.0 2.0 0.0 1.88 MB

Screen sharing pwa with remote control functionalities

Home Page: https://orchestrapwa.vercel.app

License: Creative Commons Zero v1.0 Universal

TypeScript 61.03% SCSS 6.45% Go 32.53%

orchestra's Introduction

Orchestra

I'm building this app as a project during my learning of Typescript, Go and CyberSec. The goal of this app is to simplify the sharing of small live sessions across devices.

Built with React and Go

How it works

This app currently allows users to either share their screens or get the screen of other users and control them.

How to run it?

The app works over a small local web sever written in Go and a UI made with React. The client is hosted on Vercel while the peer server is hosted on Heroku (simply add your own server via either heroku buttons, peerjs docs or leaving it blank for peerjs to use its own default servers -> One of peerjs default servers is already set up in the .env-sample file).

How to share your screen

  • Start the local server
  • Paste the given wss URL from the server in the respective field on the client.

Once "Server" is clicked the client will establish a web socket to your local server

  • Now click share screen and share the generated ID.

To watch the screen

  • Paste the ID
  • Click
  • Done!

Requirements to run the local server

Requirements to run the local server

  • Mkcert

On MacOS

# Use Homebrew
$ brew install mkcert
$ mkcert -install

On Windows

# Use Chocolatey
$ choco install mkcert
$ mkcert -install
  • Go

  • Windows -> Microsoft Visual C++ Redistributable

  • MacOS -> Xcode command line tools

  • Linux -> libXtst

How to contribute

Open a new branch describing the feature, styling or the bug fix (e.g. feature/audio-sharing) and have fun!

Current features

  • Downloadable
  • Room based sreen sharing
  • Remote control (upon request)

orchestra's People

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

orchestra's Issues

Dependency Dashboard

This issue provides visibility into Renovate updates and their statuses. Learn more

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.


  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.