Updated the README.md file and added screenshots
Added screenshots/loginpage.png for the README.md file Added screenshots/sync2clients.gif for the README.md file Added screenshots/sync4clients.gif for the README.md file Modified README.md to contain more info about the project Changed some settings in settings.json
This commit is contained in:
parent
5b96d6d8ab
commit
3476a555c0
29
README.md
29
README.md
@ -1 +1,30 @@
|
||||
# synchronized-video-streaming
|
||||
|
||||
This project is a simple web application that allows users to watch videos together in real-time, ensuring a synchronized viewing experience. This project is built in Node.js, and utilizes Web-Sockets in order to send real time updated between the client and the server.
|
||||
|
||||
## Features
|
||||
* Real-time Synchronization: All participants are watching the same video at the same time, eliminating any delays or discrepancies.
|
||||
* User-friendly Interface: The web app offers an intuitive and user-friendly interface, making it easy for users to navigate and enjoy their shared video experience.
|
||||
* Multi-User Support: Multiple users can join the same video session, allowing friends, family, or colleagues to watch videos together from different locations.
|
||||
* Video Playback Controls: Users have full control over the video playback, including play, pause and seek, ensuring a personalized viewing experience.
|
||||
* Simple Login System: A simple login page is implemented in order to allow only known people to join the hosted watch-together room.
|
||||
|
||||
|
||||
## Installation & Usage
|
||||
1. Make sure Node.js is installed, if not visit [https://nodejs.org/en/download](https://nodejs.org/en/download)
|
||||
2. Clone the repository ``` git clone https://github.com/ShakedAp/synchronized-video-streaming.git```
|
||||
3. Add your video to `/videos`, in `mp4` format
|
||||
4. Modify `settings.json`:
|
||||
- Set `ip` to your ip
|
||||
- Set `port` to the host port (make sure it is unused)
|
||||
- Set `video_path` to the path to your video: `videos/<yourvideo>.mp4`
|
||||
- Set password to a string you like
|
||||
5. Start the server: `npm start` or `node src/index.js`
|
||||
|
||||
## Screenshots
|
||||
4 Clients Synchronized:
|
||||

|
||||
Login Page:
|
||||

|
||||
2 Clients Synchronized:
|
||||

|
BIN
screenshots/loginpage.png
Normal file
BIN
screenshots/loginpage.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 169 KiB |
BIN
screenshots/sync2clients.gif
Normal file
BIN
screenshots/sync2clients.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.7 MiB |
BIN
screenshots/sync4clients.gif
Normal file
BIN
screenshots/sync4clients.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 7.0 MiB |
@ -2,5 +2,5 @@
|
||||
"server_ip": "192.168.68.118",
|
||||
"server_port": 3000,
|
||||
"video_path": "videos/shrek.mp4",
|
||||
"password": ""
|
||||
"password": "password"
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user