Skip to content

syntax-syndicate/screen-sharing-platform

 
 

Repository files navigation

Screen Sharing Application

A real-time screen sharing application built with Next.js, WebRTC, and PeerJS. Create or join rooms to share your screen with others instantly.

✨ Features

  • Real-time screen and audio sharing
  • Room-based sharing system
  • Cross-browser support
  • Simple and intuitive interface

πŸ“± Device Support

  • Hosting: Desktop/laptop browsers only
  • Viewing: Works on all devices (desktop, tablet, mobile)

🌐 Browser Support

Browser Screen Sharing Audio Sharing
Google Chrome βœ… βœ… (Only when sharing a tab)
Microsoft Edge βœ… βœ… (Only when sharing a tab)
Mozilla Firefox βœ… ❌
Apple Safari βœ… ❌

Important Notes

  • For audio sharing to work, users have to select the tab option when sharing in Google Chrome or Microsoft Edge.

πŸ› οΈ Built With

πŸš€ Getting Started

First, clone the repository:

git clone https://github.com/tonghohin/screen-sharing.git

Navigate to the project directory:

cd screen-sharing

Using npm

Install the dependencies:

npm install

Start the development server:

npm run dev

Using Docker

Start the development container:

docker compose up

πŸ“¦ Deployment

Cloud Platform

This application can be deployed on any cloud platform that supports static site hosting.

Self Hosting

You can self-host this application using Docker:

docker run -p 3000:3000 -d --name screen-sharing ghcr.io/tonghohin/screen-sharing:latest

πŸ‘₯ Contributing

Contributions are welcome! Please read our Contributing Guide for details on how to submit pull requests, report issues, and contribute to the project.

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Share your screen with one simple room code. No downloads or sign-ups required.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 84.0%
  • CSS 14.9%
  • Other 1.1%