From 5d80f7fb48b54ee366ae1296671d4c2b73c67baa Mon Sep 17 00:00:00 2001
From: "Sreedhar k.s" <53270409+mellofordev@users.noreply.github.com>
Date: Sat, 12 Jun 2021 12:51:57 +0530
Subject: [PATCH] Created Readme
Created a readme file which will help to setup and run the project locally
---
README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 46 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9b55b7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+
+
+
+
+ZOOM clone with Webrtc
+
+A Simple Zoom clone build with socket.io and Webrtc Watch the video tutorial of this project Here
+
+# Dependencies
+Following are the dependencies that are required to run this project .
+Note : Make sure that you have installed nodejs in your system , if not install it from Here
+
+ 1.express - The server we gonna use
+
+ 2.ejs - As a templating language
+
+ 3.socket.io- A channel which allows us to have real time communication with the client and server
+
+ 4.uuid -A dependency to create dynamic urls ,so that users can chat in different rooms with unique urls created
+
+ 5.nodemon- A dev dependency which allows us to automatically refresh the server
+
+ 6.peerjs -Simplifies the peer to peer video communication
+
+
+Install the following dependencies using the command below
+
+ npm i express ejs socket.io
+
+ npm i uuid
+
+ npm i --save-dev nodemon
+
+ npm i -g peer
+
+ Once you install all the dependencies we are ready to start the server
+
+ # Running locally
+ Start the nodemon server using the following command
+
+ npm run devStart
+
+ Open up new terminal and run the peer server peer --port 3001
+
+ Navigate to localhost:3000
+