HawkingRadiation42/nutshell

Summarise your recorded online video lectures in a few minutes.

Get your video lectures summed up in a few minutes.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributors

About The Project

Nutshell allows students to quickly summarise their entire video lectures in just a few minutes. Whether it's for a quick revision, catching up on missed classes, or simply a reference for what happened, Nutshell helps students by providing them with the most important parts of the class without them having to watch a second of the recorded video.

And the best part is that it's not just limited to online lectures. Anyone in need of summarising a video-based session can make use of Nutshell and get all the meat. Be it online conferences, meetings, presentations, seminars, or workshops, you just have to upload the recorded video with clear audio, and Nutshell takes care of the rest.

Nutshell leverages state-of-the-art, open-source machine learning & deep learning technologies in order to go from the original video to its short summed-up version. This allows us to provide the user with a concise, accurate and reliable summary.

(back to top)

Built With

• React.js
• Python
• FastAPI

Technologies

• Video to audio conversion Moviepy
• Speech-to-text Deepgram
• Summariser Gensim

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• pip

  pip install moviepy deepgram-sdk gensim==3.6 fastapi uvicorn

Installation

1. Get your Deepgram API Key at https://deepgram.com
2. Clone the repo

   git clone https://github.com/outoflaksh/nutshell.git

3. Install NPM packages

   npm install

4. Enter your API in api/settings.py

   DEEPGRAM_API_KEY = 'ENTER YOUR API';

5. In the api folder, run

   uvicorn api:app

6. In the root directory, run

   npm start

(back to top)

Contributors

Yathansh Tewatia - @yattew

Lakshya Malik - @outoflaksh

(back to top)