Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Sudheer121/Study-Room
[Under maintenance] Connect and study together with friends over text and voice channels, over a click of a button. Web application for chat and audio streaming.
https://github.com/Sudheer121/Study-Room
chat-application discord expressjs mesh-networks node-schedule nodejs peer-connection peerjs react react-router reactjs study-room text-channel twilio-api voice-channel voice-channels voice-chat webrtc websocket websockets
Last synced: about 1 month ago
JSON representation
[Under maintenance] Connect and study together with friends over text and voice channels, over a click of a button. Web application for chat and audio streaming.
- Host: GitHub
- URL: https://github.com/Sudheer121/Study-Room
- Owner: sudheer121
- Archived: true
- Created: 2020-12-01T15:15:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-22T06:31:56.000Z (about 1 year ago)
- Last Synced: 2024-08-04T13:05:35.189Z (5 months ago)
- Topics: chat-application, discord, expressjs, mesh-networks, node-schedule, nodejs, peer-connection, peerjs, react, react-router, reactjs, study-room, text-channel, twilio-api, voice-channel, voice-channels, voice-chat, webrtc, websocket, websockets
- Language: JavaScript
- Homepage: https://mystudyroom.netlify.app/
- Size: 16 MB
- Stars: 49
- Watchers: 5
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
Study-Room
Chat, Talk, Study....
Study, collaborate, conference ... over click of a button.
---
A fully functional 🚀 web application where students create/join rooms and communicate using text and audio channels. No registration required . The application connects peers using WebSockets and WebRTC.
Check it out [here](https://mystudyroom.netlify.app).
New Features
>
- Generate room ID and share with friends
- Directly connect to room with shared link, valid for 12 hours
- Better UI
>
>
>
>
Installation
Clone the repo
```bash
git clone https://github.com/Sudheer121/Study-Room.git
```
Start client and server in different terminals
```bash
cd client
npm i
npm start
```
```bash
cd server
cp .env.example .env
npm i
npm start
```
You are good to go !!!! .
`Note : The server uses a Twilio API (for TURN servers) for voice chat. Not required locally`
Desktop and Mobile Views
The application is compatible with both desktop and mobile phones.
Blog describing how the entire system works
- Checkout [the blog](https://sudheer.hashnode.dev/how-multimedia-streaming-apps-work).
Features
>
- Chat using text and voice channels
- Easy to use UI with everything on one screen
- Mobile Compatibility
- Connect with multiple people by choosing unique room ids
>
>
>
>
>
Technologies Used
>
- Server - Nodejs
- Client - Reactjs
- Chat - WebSockets
- Voice - WebRTC
>
>
>
>
>
The need of WebSockets and WebRTC ( short summary )
> What's the best application level protocol for enabling a bidirectional communication channel(i.e both client and server can update each other at any time) ?. HTTP works fine when the client has to request data fewer times. HTTP opens up a connection and closes the connection as soon as it gets required response. In case of a chat application we continuously need to listen for data from server, one solution is keep requesting the server for data every few milliseconds, but its resource consuming for both the sides. The solution is WebSockets, it enables a full-duplex bidirectional communication, that is, the client is always ready to listen for data pushed by server.
But WebSockets are still not peer to peer, in case of audio/video streaming between multiple peers, creating a direct peer to peer connection is a better option (because loads of data is being streamed), but this is also one of the most difficult things to do. WebRTC helps us create a direct peer to peer connetion. WebRTC is one of the most complex communication protocols because it tries all possible ways to create a peer - peer connection, if it still fails then the data is relayed via a TURN server.
Pull Request
Steps for pull request are a bit different than installation mentioned above.
>
>
>
>
>
>