Sshatzkin / Audio-Feedback

PlayBack

An online Media commenting tool for sending and receiving feedback.
Explore the Website »
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgements

About The Project

With the rise of Covid-19, education is becoming increasingly virtual. Feedback to audio and video files of performances is now much harder to make and to understand. With PlayBack, virtual feedback is now as simple as typing out a comment at the right point in the video or audio file and pressing a button. Feedback comments are associated with timestamps, helping students figure out where and what the person who gave the feedback was talking about.

Piano students can have additional help understanding feedback with the real-time piano simulator.

Built With

• HTML5

• CSS3

• JavaScript

• Firebase

  • Firebase Hosting
  • Firebase Authentication
  • Firebase Storage
  • Firebase Real-Time Database

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You will need to set up a firebase hosting and storage. Then use node package manager to install firebase tools.

• npm

  npm install -g firebase-tools

Also, enable Email and Password and Google Auth in Authentication in Firebase

Installation

1. Clone the repo

   git clone https://github.com/Sshatzkin/Audio-Feedback.git

Usage

• Aynchronous Feedback

  • Upload video and/or audio files and select the one you wish to send feedback on.
  • Press play and navigate to the timestamp you want to comment on.
  • Enter your comment at the bottom of the screen and press the add comment button.
  • Continue for as many comments as you wish to give.

• Real-time Feedback (For Piano players only as of release 1.0)

  • Select the listener or player role as necessary.
  • Invite people to the virtual room and get feedback while you play or give feedback while someone else plays.
  • You can even play the piano at the same time with others for socially distanced duet practice!

Roadmap

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.

Acknowledgements

• Firebase
• Bootstrap
• Img Shields