Skip to content

README.md

Latest commit

 

History

History
138 lines (96 loc) · 3.28 KB

README.md

File metadata and controls

138 lines (96 loc) · 3.28 KB
Raw

🌐 VideoTalk

🎥 Peer-to-Peer Video Calling App

🚀 Instantly connect with others using a unique code and enjoy seamless video calls!

🌟 Features

  • 🔗 Instant Connections: Join a video call by simply sharing and entering a unique code.
  • 🧑‍🤝‍🧑 Peer-to-Peer Communication: Powered by WebRTC for real-time media streaming.
  • 🖧 Scalable and Efficient: Built with Socket.io for robust signaling.
  • 🌎 Cross-Platform: Works seamlessly in modern web browsers.
  • ⚡ Deployed on Vercel for lightning-fast performance.

🛠 Tech Stack

Technology Purpose
🖥️ React.js Frontend Framework
📞 WebRTC Real-time media streaming
🔗 Socket.io WebSockets for signaling
⚙️ Node.js Backend server
🚀 Vercel Deployment platform

🔧 How It Works

  1. 🔑 Enter a Unique Code:
    Start or join a video call using a generated code.

  2. 📞 Peer-to-Peer Video Chat:
    Establish a real-time connection using WebRTC for smooth video and audio transmission.

  3. 🖧 Signaling Server:
    Socket.io handles signaling between peers for seamless connections.

🚀 Getting Started

🖥️ Run Locally

  1. Clone the repository:

    git clone https://github.com/hari7261/VideoTalk.git

  2. Navigate to the project directory:

    cd VideoTalk

  3. Install dependencies:

    npm install

  4. Start the server:

    npm start

  5. Open your browser and navigate to:

    http://localhost:3000

🌐 Live Demo

🌟 Try VideoTalk now: vid-talk.vercel.app

🛡 Security

  • All communication is encrypted using WebRTC protocols.
  • Only users with the correct code can join a specific call.

🤝 Contributing

Contributions are welcome! 🚀

  1. Fork the repository
  2. Create your feature branch: 
    git checkout -b feature-name
  3. Commit your changes: 
    git commit -m "Add feature-name"
  4. Push to the branch: 
    git push origin feature-name
  5. Open a pull request.

🛠️ Project Structure

VideoTalk  
├── public/           # Static files  
├── src/  
│   ├── components/   # React components  
│   ├── pages/        # Page components  
│   ├── utils/        # Utility functions  
│   └── App.js        # Main app component  
├── server.js         # Socket.io signaling server  
├── package.json      # Project configuration  
└── README.md         # Documentation

📄 License

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

Made with ❤️ by hari7261

Let me know if you'd like to add any additional customizations! 🚀