Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/123brijesh44aa/vidbrief
https://github.com/123brijesh44aa/vidbrief
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/123brijesh44aa/vidbrief
- Owner: 123Brijesh44aa
- Created: 2024-06-07T16:09:00.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-06-09T07:40:46.000Z (7 months ago)
- Last Synced: 2024-11-07T07:49:19.966Z (2 months ago)
- Language: TypeScript
- Homepage: https://vidbrief.vercel.app
- Size: 139 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VidBrief
VidBrief is a web application built with Next.js that allows users to input YouTube video URLs and receive a summary of the video content. This can be particularly useful for users who want to get the gist of a video without watching the entire content.
## Table of Contents
- [Features](#features)
- [Demo](#demo)
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [Contributing](#contributing)
- [License](#license)
## Features
- Input YouTube video URLs and generate summaries of the video content.
- User-friendly interface built with Next.js.
- API integration to process and summarize video content.
## Demo
You can see a live demo of VidBrief [here](https://your-vercel-domain.vercel.app).
## Installation
To run VidBrief locally, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/123Brijesh44aa/vidbrief.git
cd VidBrief
cd vid-brief
```
2. **Install dependencies:**
```bash
npm install
```
3. **Run the development server:**
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the application.
## Usage
1. **Input a YouTube URL:**
On the home page, enter the URL of the YouTube video you want to summarize.
2. **Get the summary:**
After submitting the URL, VidBrief will process the video and provide a summary of its content.
## API
VidBrief includes a custom API for processing YouTube videos. The API endpoint is located at `/api`.
### Example Request
To use the API, make a GET request to `/api` with the `yt-url` parameter.
```javascript
const yt_url = 'https://www.youtube.com/watch?v=example';
const apiResponse = await fetch(`/api?yt-url=${yt_url}`, {
method: 'GET',
cache: 'no-cache',
});