Skip to content

Latest commit

 

History

History
87 lines (54 loc) · 2.19 KB

README.md

File metadata and controls

87 lines (54 loc) · 2.19 KB

PeerConnect Client 🚀

The PeerConnect Client is the frontend application of the PeerConnect platform, enabling seamless real-time peer-to-peer communication using WebRTC. This client interacts with the backend to establish WebSocket connections and manage signaling for WebRTC calls using Peerjs.

🌟 Features

  • Real-time audio and video communication.
  • Peer-to-peer connection using Peerjs.
  • Dynamic room creation and participant management.
  • Chat feature for text-based communication.
  • Secure connections and event signaling via WebSocket.

🛠 Tech Stack

  • Next: Frontend framework for building the user interface.
  • Tailwind: Styling for modern and responsive design.
  • WebRTC: For peer-to-peer media streaming, implemented using Peerjs.
  • WebSockets: For signaling, event management and real-time communication and chat.

🚀 Getting Started

Installation

  1. Clone the repository:

    git clone https://github.com/dheerajGits/PeerConnect-client.git
cd PeerConnect-client`

  2. Install dependencies:

    `npm install

  3. Environment Setup:

    Create a .env.local file in the project root and add the following variables:

    env

    MAIN_API_URL=<Backend API URL># http://localhost:3030
MAIN_PEERJS_SERVER_URL=<PEERJS SERVER URL>` #http://localhost:8080

Running the Application

  1. Start the development server:

    npm run dev

  2. Open your browser and navigate to:
    http://localhost:3000

🤝 Contributing

Contributions are welcome! If you'd like to contribute, please:

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

📧 Contact

For queries or suggestions, feel free to reach out:

Let's connect the world one peer at a time! 🌐