Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #85

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 31 additions & 165 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,185 +1,51 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

<p align="center">
<img src="https://readme-typing-svg.herokuapp.com/?color=45ffaa&size=40&width=900&height=80&lines=Welcome%20to%20Videocall%20Webapp"/>
</p>
<p align="center">
<a href="https://reactplay.io" target="_blank" style="font-size:80px"><img src="https://github.com/Ankesh-erek/nextjs-videocall-webapp\client\public\Logo.png" alt="react-play" width="300" /></a>
</p>

<p align="center">

<a href="https://github.com/Soumojitshome2023/nextjs-videocall-webapp"><img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103"></a> <a href="https://github.com/Soumojitshome2023/nextjs-videocall-webapp/blob/master/LICENSE"><img src="https://img.shields.io/badge/MIT-Licence-blue.svg?v=103"></a>

![GitHub issues](https://img.shields.io/github/issues/Soumojitshome2023/nextjs-videocall-webapp)
![GitHub pull requests](https://img.shields.io/github/issues-pr/Soumojitshome2023/nextjs-videocall-webapp)
![GitHub forks](https://img.shields.io/github/forks/Soumojitshome2023/nextjs-videocall-webapp)
![GitHub Repo stars](https://img.shields.io/github/stars/Soumojitshome2023/nextjs-videocall-webapp?style=social)
![GitHub contributors](https://img.shields.io/github/contributors/Soumojitshome2023/nextjs-videocall-webapp)
<br/>
![Repo Size](https://img.shields.io/github/repo-size/Soumojitshome2023/nextjs-videocall-webapp)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github?af=5236ad)
<br/>
![Visitors Count](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2FSoumojitshome2023%2Fnextjs-videocall-webapp&label=visitors&countColor=%2337d67a&style=flat&labelStyle=upper)
</p>

## Table of Contents
1. [Introduction](#introduction)
2. [Live Demo](#live-demo)
3. [Tech Stack](#tech-stack)
4. [Features](#features)
5. [Installation Guide](#installation-guide)
6. [Contributing Guide](#contributing-guide)
7. [Outreach](#outreach)
8. [Project Admin](#project-admin)
9. [Code of Conduct](#code-of-conduct)
10. [Contributors](#contributors)
11. [License](#license)
12. [Support](#support)


## ✨🎈Introduction
**Nextjs-videocall-webapp** is a modern web application enabling real-time video communication. It’s designed for users looking to connect with others quickly and efficiently. With state-of-the-art technologies such as WebRTC and Socket.IO, users can engage in high-quality video calls that adapt to different network environments.
### Use Case:
- Virtual meetings
- Study sessions
- Remote interviews
- Social hangouts
### Key Functionality:
- Real-time video calls
- Peer-to-peer communication
- Minimal latency with WebRTC

## 🖱️Live Demo
## <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/People%20with%20professions/Man%20Technologist%20Medium%20Skin%20Tone.png" alt="man-techno" height=50 width=50>
Visit Video Calling WebApp (https://soumojit-nextjs-videocall-webapp.vercel.app/) to see the live demo


## ⌨️Tech Stack

- **Next.js**: React framework for server-side rendering and building scalable web applications.
- **WebSocket**: Enables full-duplex communication between the client and server, providing real-time updates and interactions.
- **WebRTC**: Powers peer-to-peer connections for live video and audio streaming.
- **Node.js**: Backend runtime for scalable network applications.
- **Styled-Components**: For creating reusable, maintainable styles within React components.
- **Vercel**: Deployment platform for Next.js apps.

## 💻Features

-🔄 **Real-time Communication:** Utilizes WebRTC and Socket.IO to provide instant connections between peers.
- 📡 **Low Latency:** Optimized for smooth video streaming even on slower connections.
- 🎥 **Video and Audio Support:** High-definition video and audio features.
- 🖥️ **Responsive UI:** Adaptive design for desktop and mobile platforms.
- 🔒 **Secure Communication:** All communications are peer-to-peer, ensuring privacy.
- 📦 **Server-Side Rendering (SSR):** Fast, SEO-friendly pages thanks to Next.js.


## 🧑🏻‍💻Installation Guide

1. *Clone this repository to your local machine:*

```
git clone https://github.com/your-username/nextjs-videocall-webapp.git
cd nextjs-videocall-webapp
```
2. *Install the required dependencies:*
```
npm install
```

3. *Setup environment variables*
Create a .env.local file in the root directory and add the following values:
```
SOCKET_IO_SERVER_URL=http://localhost:3001
NEXT_PUBLIC_RTC_CONFIG={"iceServers": [{"urls": "stun:stun.l.google.com:19302"}]}
```
4. Run the application
For development:
```
npm run dev
```
For production:
```
npm run build
npm start
```

## 🛠️ Contributing Guide

We welcome contributions to the **videocall webapp** project! To contribute:
1. Fork the repository
2. Create a feature branch (`git checkout -b feature-name`)
3. Commit your changes (`git commit -am 'Add new feature'`)
4. Push to the branch (`git push origin feature-name`)
5. Create a new Pull Request

Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) for more detailed information.

## Getting Started

## 💪 Outreach
First, run the development server:

HelpOps-Hub is proudly part of global initiatives engaging with passionate developers and open-source enthusiasts worldwide:

<table>
<tr>
<th>Name</th>
<th>Logo</th>
<th>Purpose</th>
</tr>
<tr>
<td>GSSoC'2024-Extd </td>
<td><img src="https://github.com/user-attachments/assets/1bd8ab15-604e-4ac9-a33e-dc753a07be23" alt="a white background with the text, GirlScript Summer of Code next to an orange flower"></td>
<td> The coding period is from October 1st to October 30th, during which contributors make contributions and earn points on the platform. </td>
</tr>
<tr>
<td>Hacktoberfest 2024 </td>
<td><img src="https://github.com/user-attachments/assets/027eb349-43f2-4834-9343-1e8ba0bf54ed" alt="a black background with the official logo of Hacktoberfest 2024"></td>
<td> Hacktoberfest is a month-long October event welcoming all skill levels to join the open source community, contribute quality pull requests on GitHub, and earn cool swag. </td>
</tr>
</table>


<h1 align=center>

## Project Admin

<img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/People%20with%20professions/Man%20Technologist%20Medium%20Skin%20Tone.png" alt="man-techno" height=40 width=40> </h1>
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

<p align="center">
<a href="https://github.com/Soumojitshome2023"><img src="https://avatars.githubusercontent.com/Soumojitshome2023" width="17%" /></a>
</p>
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

<div align="center">
<p margin-right="10px 30px 100px 30px">
You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file.

<a href="https://www.linkedin.com/in/soumojit-shome/" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/linked-in-alt.svg" alt="https://www.linkedin.com/in/soumojit-shome" height="30" width="40" /></a>
</p>
</div>
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## 📑Code Of Conduct
---

This project and everyone participating in it is governed by the [Code of Conduct](https://github.com/vansh-codes/Gityzer/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
## 👀 Our Contributors

- We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating this project to greater heights.
- Make sure you show some love by giving ⭐ to our repository.

<div align="center">

<a href="https://github.com/Soumojitshome2023/nextjs-videocall-webapp">
<img src="https://contrib.rocks/image?repo=Soumojitshome2023/nextjs-videocall-webapp&&max=100" />
</a>
</div>

## 📝License
---

<img src="https://img.shields.io/badge/License-MIT-yellow.svg"/> <br>
Gityzer is licensed under the terms of the MIT License. check out <a href="./LICENSE">LICENSE</a> for details. <img width=2300/>
## Learn More

<a name="support"></a>
To learn more about Next.js, take a look at the following resources:

## ⭐Support
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

- 💰 Become our [Sponsor](https://github.com/sponsors/Soumojitshome2023)!
- ⭐ Star our Repo
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

# 🎉Big thanks to all the contributors!
## Deploy on Vercel

<a href="https://github.com/Soumojitshome2023/nextjs-videocall-webapp/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Soumojitshome2023/nextjs-videocall-webapp" />
</a>
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

<p align="right">(<a href="#top">Back to top⬆️</a>)</p>
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.