/VideoKon_SDK

Video Conferencing Web application in development made using Nodejs, WebRTC & Socket.io

Primary LanguageJavaScript

Modern Authenticated Meetings
home login meeting

VideoKon 🎦

Technologies Getting Started API Endpoints Collaborators Contribute

Our goal is to develop a robust real-time communication platform utilizing WebRTC and Socket.io, with a focus on scalability and also providing Integrations to other software

🌐 Will be live soon

💻 Technologies

-> Node js

-> React js

-> WebRTC

-> Socket.io

->MongoDB

🚀 Getting started

Prerequisites

Here you list all the prerequisites necessary for running your project. For example:

Project Installation

  1. Clone the repository:
git clone https://github.com/dr-naikare/VideoKon_SDK.git
  1. Redirect to both directories (frontend & backend) separately using
cd \VideoKon_SDK\frontend
cd \VideoKon_SDK\backend
  1. Install dependencies in both directories:
 npm install

Few Important Steps

->Make sure to place a file named '.env' in the \VideoKon_SDK\backend directory. This file should contain your database URI and JWT key. Below is the directory structure for better understanding

📦backend
 ┣ 📂config
 ┣ 📂controllers
 ┣ 📂middleware
 ┣ 📂models
 ┣ 📂routes
 ┣ 📂utils
 ┣ 📜.env
 ┣ 📜package.json
 ┗ 📜server.js

.env file Data

MONGO_URI= mongodb://localhost:27017/<database>
JWT_SECRET=anyrandomsecretkey

More info related JWT secret key

Running the Project

Running the server Running the front end
# Assuming you are in /backend directory
# If not then cd \VideoKon_SDK\backend
npm start
# Assuming you are in /frontend directory
# If not then cd \VideoKon_SDK\frontend
npm run dev

📍 API Endpoints

Coming Soon ...

🤝 Collaborators

Special thank you to all the people who contributed to this project.

Mustafa Bhikhapurwala Profile Picture
Mustafa Bhikhapurwala
Suyash Naikare Profile Picture
Suyash Naikare
 Mohammed Bariyawala Profile Picture
Mohammed Bariyawala

📫 Contribute

Other developers can contribute to this project.

  1. Clone or Fork
  2. Create your own branches
  3. Follow commit patterns
  4. Open a Pull Request explaining the problem solved or feature made, if it exists, append a screenshot of visual modifications and wait for the review!

Documentations that might help

Coming Soon ...