Skip to content
/ Lesser Public

Lesser, your Youtube video summarizer. Save time by checking a summary of your video to know what it's about and whether you're interested or not.

Notifications You must be signed in to change notification settings

Exhore/Lesser

Repository files navigation


Logo

Lesser. Your youtube video summarizer.

View Demo · Report Bug · Request Feature

Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact

About The Project

Lesser is a web application focused on summarize youtube content in a matter of seconds. The idea is simple: You want to know about the main ideas of a video, or what the video is about. Or you simply want a summary of the information the speaker is trying to convey without ads and without interruptions, powered by AI.

This application is a SPA. It runs on InertiaJS technology, which is a 'glue' between the front-end and back-end (vue + laravel). This makes the program feel responsive and fast.

  • 📱 Web is responsive with all kind of devices.
  • 🏃 Faster than light 💡 - being a SPA, the app runs smoothly!
  • 🔒 Secure storage - Users can be registered with 2FA for secure their accounts and sessions.

Youtube video explaining the concept

IMAGE ALT TEXT

Image collab

Logo

(back to top)

Built With

Vue.js Laravel MySQL TailwindCSS inertia InertiaJS ChatGPT YouTube

(back to top)

USE CASE DIAGRAM

use cases

E-R DATABASE MODEL

erDiagram

UML DIAGRAM

uml diagram

Getting Started

If you don't want to use the App in my website, you can also run it in local. There are few steps to do that.

Prerequisites

List of prerequisites you need to use the software and how to install them.

  • Python 3.10+
  • php 8.0+, composer, laravel
  • All dependencies in package.json that will be installed with npm later.
  • Mysql database
  • Nodejs, npm

Installation

Below there is the requirements dependencies to install the program and run it in local.

  1. Contact me to get the OpenAI API key. Without API KEY, you CANNOT run the program.

  2. Clone the repo

    git clone https://github.com/Exhor/Lesser.git
  3. Install NPM packages

    npm install
  4. Install Composer dependencies

    composer install

  5. Put the '.env' file in root folder

  6. Do the migrations

     php artisan migrate
    
  7. Create symbolic link for public and storage

    php artisan storage:link
    
  8. Pip dependencies for execute python scripts

pip install python-dotenv
pip install openai
pip install youtube-transcript-api
pip install yt-dlp

(back to top)

Testing

Tests can be found in 'test' folder. You can check tests by running the following command

php artisan test 

Usage

Here's how:

  • You choose a URL of a youtube video and paste it in the input box of the website.
  • A connection is established with the OpenAI API and Youtube to collect the subtitles of the videos, process them to summarize them and deliver them to you.
  • In less than 5 seconds, you have your summary ready 😄

(back to top)

License

MIT

(back to top)

Contact

Nelson Rivera - [email protected]

(back to top)

About

Lesser, your Youtube video summarizer. Save time by checking a summary of your video to know what it's about and whether you're interested or not.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published