Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tonghohin/screen-sharing
Real-time Screen Sharing App. Easy to use—no installation or registration required.
https://github.com/tonghohin/screen-sharing
Last synced: 3 months ago
JSON representation
Real-time Screen Sharing App. Easy to use—no installation or registration required.
- Host: GitHub
- URL: https://github.com/tonghohin/screen-sharing
- Owner: tonghohin
- Created: 2024-11-04T16:55:19.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-28T23:02:09.000Z (3 months ago)
- Last Synced: 2024-11-28T23:27:11.214Z (3 months ago)
- Language: TypeScript
- Homepage: https://share-your-screen.vercel.app
- Size: 223 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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
- [Next.js](https://nextjs.org/) - React framework
- [PeerJS](https://peerjs.com/) - WebRTC abstraction
- [Tailwind CSS](https://tailwindcss.com/) - Styling
- [shadcn/ui](https://ui.shadcn.com/) - UI components
## 🚀 Getting Started
First, clone the repository:
```bash
git clone https://github.com/tonghohin/screen-sharing.git
```
Navigate to the project directory:
```bash
cd screen-sharing
```
### Using npm
Install the dependencies:
```bash
npm install
```
Start the development server:
```bash
npm run dev
```
### Using Docker
Start the development container:
```bash
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:
```bash
docker run -p 3000:3000 -d --name screen-sharing ghcr.io/tonghohin/screen-sharing:latest
```
## 👥 Contributing
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) 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](LICENSE) file for details.