Skip to content

Neilblaze/Sharkroom

Repository files navigation


Sharkroom

A room for humans to interact with 🦈
View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Sharkroom

Sharkroom's based on Tensorflow.js, where the main goal is to provide a next level teaching experience between teachers and childrens specifically toddlers 👶. In this COVID-19 pandemic, teaching on Work from Home basis has become a great mess, especially for toddlers. Here project Sharkroom comes to the rescue. Sharkroom provides p2p video conferencing via WEBRTC between 'Sharkman' and 'n' number of person with accurate live captioning & download feature! Sharkroom is easy to use & requires no custom application/software installation. Just click on View Demo & wait for the model to load & you're good to go!

  • It is supported across all updated browsers.
  • WEBRTC p2p realtime video chat room (Shark & User)
  • Provides 80% accurate live captioning for free on realtime.
  • Embedded Dark mode feature!
  • Download captions as .txt

Built With

  • Server running on GCP. Thanks to MLH for providing free GCP credits!

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • yarn
sudo apt install yarn

Installation

  1. Clone the repository:
git clone https://github.com/Neilblaze/Sharkroom.git
cd Sharkroom
  1. Install dependencies and prepare the build directory:
yarn
  1. To watch files for changes, and launch a dev server:
yarn watch

Now you're ready to do something awesome!

Platform support

Demos are supported on all Chromium Browsers including iOS Safari.

It should also run on Chrome on Android and potentially more Android mobile browsers though support has not been tested yet.

Roadmap

  • Add on-screen canvas video screen-recording & screen-capturing feature. Although we have avoided that because of GDPR privacy protocols.
  • Add more characters (Currently on Sharkman v1.0)
  • Custom Background set feature.
  • Multilanguage realtime translation support!
  • Direct interaction with Zoom, Google Meet & similar softwares.
  • Creating a native Android™/Flutter™ app.

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Contact

This project is maintained by ➡️ Pratyay Banerjee ⚡, Sandipan Dey 🍕, Harshita Raj 😎

Crafted with ♥ for SharkHacks by Pratyay Banerjee, Sandipan Dey and Harshita Raj


Sharkroom

About

A room for humans to interact with 🦈

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages