https://github.com/ubclaunchpad/sync

:tv: Interactive, synchronized YouTube streaming
https://github.com/ubclaunchpad/sync

react socket-io typescript ubc webrtc websockets youtube

Last synced: 3 months ago
JSON representation

:tv: Interactive, synchronized YouTube streaming

• Host: GitHub
• URL: https://github.com/ubclaunchpad/sync
• Owner: ubclaunchpad
• License: mit
• Created: 2019-10-17T05:34:25.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-10-02T05:32:28.000Z (over 2 years ago)
• Last Synced: 2023-03-01T20:36:56.403Z (almost 2 years ago)
• Topics: react, socket-io, typescript, ubc, webrtc, websockets, youtube
• Language: TypeScript
• Homepage: https://sync.ubclaunchpad.com
• Size: 57.9 MB
• Stars: 23
• Watchers: 46
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/funding.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
Sync




  

    

  

  


  

    

  

  

    

  





  

    

  



___NOTE: This project is no longer actively maintained.___

Sync is a synchronous YouTube streaming app for you to watch, share, and talk about videos with your friends. Create stream rooms with your friends. Chat and video call your friends and create endless playlists to watch videos together.

## Contributing

### Dependencies

To get started, install the following dependencies: 

- [Node.js](https://nodejs.org/)

- [Redis](https://redis.io/)

- [Docker](https://www.docker.com/) (optional)

### Frontend

The frontend is a React app in the *frontend* directory. Run `npm install` to install all project dependencies. Run `npm run dev` to start the React development server. The *Launch & Debug Chrome (Frontend)* launch configuration can be used to attach a debugger to the React process and debug from VS Code.

### Backend

The backend is a Node.js Express server in the *backend* directory. Run `npm install` to install all project dependencies. Before starting the backend, start Redis server. Run `npm run dev` to start the Node.js server. It auto restarts the process on code changes. The *Attach Debugger (Backend)* launch configuration can be used to attach a debugger to the running process. Use the *Launch & Debug (Backend)* launch configuration to launch the Node process and attach a debugger from VS Code.

 

### Docker

The development environment can be run all through Docker. Simply run `docker-compose up` to spin up the frontend, backend, and Redis containers.