[!NOTE] The main branch is meant to be used with vidsum-api. It WILL NOT work without the backend. All information in this README is given for the main branch. Refer to the deployment branch to use VidSum independently!

VidSum – YouTube Video Summarizer

VidSum is a video/lecture summarization tool built with SvelteKit and yt-dlp that lets you quickly generate and save summaries of YouTube videos. Paste a YouTube link, choose your summary preferences, and get a concise, readable summary—perfect for note-taking, studying, or sharing insights.

Features

• YouTube Summarization: Paste any YouTube URL and get an AI-generated summary.
• Customizable Output: Choose summary length (Short, Medium, Long) and video type (Education, Entertainment, Others).
• Save Notes: Add a title and save your summaries for later reference.
• Modern UI: Built with TailwindCSS and Bits UI for a clean, customizable interface.

Tech Stack

• SvelteKit
• Supabase (backend, storage)
• TailwindCSS (styling)
• Bits UI (UI components)
• markdown-it (Markdown rendering)
• carta (Markdown editing)
• svelte-sonner (toasts/notifications)

Getting Started

1. Clone the repository:

   git clone https://github.com/JHAhmed/vidsum.git
   cd vidsum
   

2. Install dependencies:

   pnpm install
   

3. Configure environment variables:

   • Copy .env.example to .env and fill in your Supabase and Gemini/OpenAI credentials.

4. Set up backend:

   • Ensure you have the vidsum-api repository cloned and running.

5. Run the development server:

   pnpm run dev
   

6. Open your browser:

   • Visit http://localhost:5173

Usage

1. Paste a YouTube video URL into the input field.
2. Select your desired summary length and video type.
3. Click Get Summary to generate a summary.
4. (Optional) Add a title and click Save Summary to store your note.

Built with ❤️ using SvelteKit, Supabase, TailwindCSS, and Bits UI.