https://github.com/venkatk-git/stream

https://github.com/venkatk-git/stream

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/venkatk-git/stream
• Owner: venkatk-git
• Created: 2024-12-14T13:46:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-02T14:50:11.000Z (over 1 year ago)
• Last Synced: 2025-04-06T23:21:52.007Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 693 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Stream: Real-Time Collaborative Video Platform 🎥

[![Project Status](https://img.shields.io/badge/status-active-%23success.svg)](https://github.com/venkatk-git/stream)

[![GitHub Issues](https://img.shields.io/github/issues/venkatk-git/stream)](https://github.com/venkatk-git/stream/issues)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

A platform for watching YouTube videos with friends in real-time, synchronized across all devices. Built with modern web technologies.

**Live Demo:** [Coming Soon]  

## Features ✨

- **Real-Time Video Sync** 🕒  

  Simultaneous playback using WebSocket communication

- **Session Management** 🔐  

  Persistent rooms with Redis-backed storage

- **Responsive UI** 📱  

  Mobile-friendly interface with Tailwind CSS

## Tech Stack 🛠️

**Frontend**  

![React](https://img.shields.io/badge/-React-61DAFB?logo=react&logoColor=white)

![Tailwind CSS](https://img.shields.io/badge/-Tailwind_CSS-38B2AC?logo=tailwind-css&logoColor=white)

**Backend**  

![Node.js](https://img.shields.io/badge/-Node.js-339933?logo=node.js&logoColor=white)

![Socket.IO](https://img.shields.io/badge/-Socket.IO-010101?logo=socket.io)

**Database**  

![Redis](https://img.shields.io/badge/-Redis-DC382D?logo=redis&logoColor=white)

## Installation ⚙️

1. Clone the repository:

   ```bash

   git clone https://github.com/venkatk-git/stream.git

   cd stream

   ```

2. Set up backend:

   ```bash

   cd server

   npm install

   cp .env.example .env # Add your Redis/YouTube API credentials

   npm start

   ```

3. Set up frontend:

   ```bash

   cd ../client

   npm install

   npm run dev

   ```

## Usage 🚀

1. Visit `http://localhost:4200`

2. Create a new room or join existing one

3. Paste YouTube URL and watch with friends!

4. Use chat for real-time communication

## API Reference 🌐

| Endpoint | Method | Description |

|----------|--------|-------------|

| `/api/rooms` | POST | Create new viewing room |

## Roadmap 🗺️

- [ ] User authentication system

- [ ] Video queue management

- [ ] Screen sharing capability

## Contributing 🤝

1. Fork the project

2. Create your feature branch:

   ```bash

   git checkout -b feature/amazing-feature

   ```

3. Commit changes:

   ```bash

   git commit -m 'Add amazing feature'

   ```

4. Push to branch:

   ```bash

   git push origin feature/amazing-feature

   ```

5. Open a Pull Request

---

**Connect with me:**  

[![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=github)](https://github.com/venkatk-git)

[![LinkedIn](https://img.shields.io/badge/-LinkedIn-0A66C2?logo=linkedin)](https://linkedin.com/in/venkatkumar-m-77ba842a7)

[![Portfolio](https://img.shields.io/badge/-Portfolio-000000?logo=vercel)](https://v3nkat.vercel.app)

```