Giter VIP home page Giter VIP logo

quickvid's Introduction

QuickVid

Your AI-Powered Video Summarization Tool

GIF

Twitter License

Introduction · Installation · Tech Stack · Implementation · Contributing · Snapshots


Introduction

QuickVid is an open-sourced video summarization tool built with Whisper, GPT, LangChain & Supabase.

With QuickVid, you can save time and get the essence of any YouTube video with our intelligent summarization.

Installation

Local Installation

  1. Clone the Repository
    git clone https://github.com/metaloozee/quickvid
    cd quickvid
  2. Install Dependencies
    [pnpm | npm | yarn] install
  3. Set Environment Variables
    NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
    
    replace your_supabase_url and your_supabase_anon_key with the actual values of your Supabase project.
  4. Run the Application
    [pnpm | npm | yarn] run dev
    this will launch the application, and you can access it by visiting http://localhost:3000 in your web browser.

Docker Installation

  1. Clone the Repository
    git clone https://github.com/metaloozee/quickvid
    cd quickvid
  2. Set Environment Variables
    NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
    
    replace your_supabase_url and your_supabase_anon_key with the actual values of your Supabase project.
  3. Build the Docker Image
    docker build -t quickvid .
  4. Run the Docker Container
    docker run -p 3000:3000 --env-file .env.local quickvid
    this will launch the Next.js application inside the Docker container, and you can access it by visiting http://localhost:3000 in your web browser.

Tech Stack

Implementation

QuickVid is built as a standard Next.js application with the shadcn/ui template kit. The following technologies and services are used:

ytdl-core is used to download the YouTube video as an audio file.

Supabase Storage is used as an Amazon S3 alternative to store and serve the audio files generated by ytdl-core.

OpenAI's Whisper is used to perform speech-to-text operation on the particular audio file.

LangChain is used to process the transcript using its Summarization Chain which summarizes a document by dividing it into small chunks.

Contributing

We love our contributors! Here's how you can contribute:

  • Open an issue if you believe you've encountered a bug.
  • Make a pull request to add new features/make quality-of-life improvements/fix bugs.

Author

License:

QuickVid is open-sourced under the GNU General Public License Version 3 (GPLv3) or any later version. You can find it here

Snapshots:

Home Page Home Page Light

Generate Generate Light

quickvid's People

Contributors

metaloozee 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.