Giter VIP home page Giter VIP logo

cs-5337's Introduction

CS-5337


About The Project

A Full-Stack WebXR Project built with an intention to solve the problem of remote collaboration virtually with the help of 3D realistic rooms.

This project makes users collaborate virtually with 3D objects, audio/video/chat communication. It gives them ability to move around the room virtually with arrow keys, annotate on 3D objects, share video/images/pdf files in sync among all users in the same room.

All above features can be accessed directly from browsers without any installations on user's end.

Built With

  • Three.JS
  • WebXR
  • WebRTC
  • Socket.io
  • Google Cloud Functions
  • Firebase Hosting

Getting Started

Since this project is hosted on firebase and uses firebase's Realtime Database, Storage, Hosting services, Having Firebase command line tools becomes an base tool for entering into development.

Prerequisites

  • Node.js
  • Firebase Command Line tool npm
    npm install -g firebase-tools

Installation

  1. Clone the repo
    git clone https://github.com/Vaishya26/CS-5337.git
  2. Change Directiory to /functions to land on main project.
    cd functions
  3. Install NPM packages
    npm install
  4. Log into Firebase Project of CS-5337 using Google Sign-in after following command
    firebase login

Usage

  1. To start Local Development and Testing server
    firebase emulators:start
  2. To deploy current branch on main server
    firebase deploy -m "Deployment Tag"

Usage (From Deployed URL)

  1. Go to URL(https://cs5337.web.app)
    Sign Up and Login by clicking on sign up link.
    Create a Room with credentails and join the room.
    Try to Upload Models (GLTF/GLB), Videos, Images, PDF files by clicking on Upload Button.
  2. To Move around and Interact with the scene.
    Use Arrow Keys to move around the 3D Scene.
    Clicking mouse down with mouse Left Key and dragging the mouse helps to turn around from single point.
  3. Demo Video for understanding usage.

License

Distributed under the MIT License. See LICENSE for more information.

cs-5337's People

Contributors

vaishya26 avatar arpitajnalens avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.