Welcome to the Peers! This is a real-time vido and audio communication application with with a focus on simplicity and reliability. This project is built with on WebRTC and Socket.io (for the real-time video and audio communcations), Next.js, Node.js and Typescript.
Peers is built as a mono-repo, with the client and server code in the same repository. To install and run the application, follow these steps:
-
Clone the repository:
git clone https://github.com/UcheSylvester/peers.git -
Navigate to the frontend project directory:
cd peers/client -
Install the necessary dependencies:
yarn -
Configure your enviroment variables by creating a
.envfile and adding the needed variables, see.env.example -
Run the application:
yarn dev
-
Still within the
peersrepository, navigate to the backend project directory:cd peers/server -
Install the necessary dependencies:
yarn -
Configure your enviroment variables by creating a
.envfile and adding the needed variables, see.env.example -
Run the application:
yarn dev
We welcome contributions from the community to make Peers even better. Whether it's bug fixes, new features, or improvements to documentation, your input is valuable. To contribute, follow these steps:
- Create an issue describing the feature/bug you want to work on.
- Fork the repository on GitHub.
- Create a new branch for your changes.
- Make your changes and commit them with descriptive messages.
- Submit a pull request to the main repository.
Peers is open-source software released under the MIT License. You are free to use, modify, and distribute it according to the terms of this license.
Thank you for choosing Peers for your video and audio communication needs. If you have any questions or feedback, please don't hesitate to get in touch.