From 51cdaa4eddf7c6ce5d9b3ff11c6ef3476ba579c5 Mon Sep 17 00:00:00 2001
From: Aditya Routh <78529538+adiiiii13@users.noreply.github.com>
Date: Fri, 1 Nov 2024 14:34:56 +0530
Subject: [PATCH] Update README.md
---
README.md | 196 +++++++++---------------------------------------------
1 file changed, 31 insertions(+), 165 deletions(-)
diff --git a/README.md b/README.md
index c130bed..925fb32 100644
--- a/README.md
+++ b/README.md
@@ -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).
-
-
-
-
-
-
-
-
-
-
-
-![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)
-
-![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)
-
-![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)
-
-
-## 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
-##
-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:
-
-
-
- Name |
- Logo |
- Purpose |
-
-
- GSSoC'2024-Extd |
- |
- The coding period is from October 1st to October 30th, during which contributors make contributions and earn points on the platform. |
-
-
- Hacktoberfest 2024 |
- |
- 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. |
-
-
-
-
-
-
- ## Project Admin
-
-
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
-
-
-
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-
+You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file.
-
-
-
+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.
- ## 📝License
+---
-
-Gityzer is licensed under the terms of the MIT License. check out LICENSE for details.
+## Learn More
-
+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
-
-
-
+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.
-(Back to top⬆️)
\ No newline at end of file
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.