aidMe

A multi-users' video streaming/uploading whiteboard

Team

• Product Owner: David Platt
• Scrum Master: Amelia Brown
• Development Team Members: Amelia Brown, David Platt, Jordan Taylor, Yu-An Lo

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

npm install, npm start

Requirements

• Node 6.2.2
• Video Cam
• React 15.3.1

To run the app:

• npm install
• npm build - terminal 1
• npm start - terminal 2

Development

This app allows users to collaboratively draw on top of videos. The user can either create a room or join an existing room. The room creator chooses whether to upload a video or to live stream a video. The app is built in react, and both the room creator and the clients are served the same page, depicting the same room in which they can draw on top of the video, chat, and take snapshots.

General Control Flow: Uploading: -user creates room and uploads video -server receives video and serves it in a socket event to the other clients

Streaming: -user creates room and streams video -at set time periods the user will emit socket events containing frames -the server recieves these frames and send them to the other clients

Frontend Scheme: One component with two different html's based on the socket events.

Uploading:
    VideoPlayer
    Canvas
Streaming:
    VideoPlayer
    Canvas
    Canvas

Installing Dependencies

From within the root directory:

• npm install, npm start

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.