Skip to content

Fahad-Mahmood/webrtc-one-to-one-client

Repository files navigation

Contributors Forks Stargazers Issues


WebRTC One-to-One Video Chat

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License

About The Project

A simple one-to-one video chat application developed using webrtc mesh architecture.

Primary features include:

  • Ability to create and join different rooms.
  • Selection of audio/video devices for video chat.
  • Media processing and audio voice filtering.

(back to top)

Built With

Following Tech Stack is used in the project:

  • Next
  • React
  • Typescript
  • Mui
  • Socket

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure the signaling server is installed and running. To find more details, check the github repository.

Installation

  1. Clone the repo
    git clone https://github.com/Fahad-Mahmood/webrtc-one-to-one-client.git
  2. Install NPM packages
    npm install
  3. Enter Signaling URL in .env.local
    const NEXT_PUBLIC_SOCKET_SERVER = 'ENTER SIGNALING SERVER URL';
  4. Run application using npm run dev in the terminal

(back to top)

Roadmap

  • Voice or Video mute and unmute during the call
  • Setup screen sharing feature on call
  • Use of twilio turn server instead of google stun
  • Show statistics durnig call for example bitrate.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Releases

No releases published

Packages

No packages published

Languages