Glowing Telegram Video Editor (WIP)

Heads up!

I'm currently working on this project. It's not ready for any use yet.

Everything written below is written from the perspective of what I'm planning to do. It's not a reflection of what's already done.

Overview

The Glowing Telegram Video Editor is a web-based Single Page Application (SPA) designed to review and edit video highlights, moments that require additional attention, and possible transcription errors, and select clips for rendering. This application aims to provide an intuitive interface for vetting and correcting data to feed into an automated pipeline that posts edited stream VODs to YouTube.

It is part of the larger glowing-telegram tool: https://github.com/saebyn/glowing-telegram

Goals

• Enable users to review, edit, and manage video highlights, attentions, and transcription errors efficiently.
• Provide synchronized video/audio playback while reviewing AI generated information to verify and adjust markers for highlights accurately.
• No need to import/export data with other tools, as the application is integrated directly into the larger glowing-telegram tool.
• Ensure usability on various screen sizes, with a primary focus on desktop use.

Key Features

• Data Review and Highlighting
  • Main Dashboard:
    • Header: Contains the application logo, navigation menu (Home, Highlights, Attentions, Transcription Errors), and a user profile section with logout functionality.
    • Sidebar: Quick links to different sections (Highlights, Attentions, Transcription Errors) and a search bar for easy navigation.
    • Content Area: Displays summary statistics (total highlights, attentions, transcription errors) and a button to add new entries.
  • Highlights Section:
    • List View: A table displaying highlights with columns for Start Time, End Time, Description, Reasoning, and Actions (Edit, Delete).
    • Detail/Edit View: A form for detailed editing with timestamp pickers and text areas for description and reasoning, including Save, Cancel, and Delete buttons.
  • Integrated Timeline and Video Playback:
    • Timeline: Display highlights, attentions, and transcription errors on a single, integrated timeline with color-coded markers and zoom/pan functionality.
    • Video Player: Synchronized video/audio playback with controls (play, pause, seek, speed control) and a current timestamp indicator.
  • Attentions Section:
    • List View: Similar to the Highlights section, with columns for Start Time, End Time, Description, Reasoning, and Actions (Edit, Delete).
    • Detail/Edit View: A form for editing attention details.
  • Transcription Errors Section:
    • List View: A table with columns for Timestamp, Category, Description, and Actions (Edit, Delete).
    • Detail/Edit View: A form for editing transcription error details, including a dropdown for category selection and text area for description.
• Project Assembly and Delivery
  • TBD

Design Decisions

• Integrated Workflow: Focused on providing a seamless experience by integrating the UI directly into a larger tool without need to import/export data to external tools.
• Responsive Layout: Designed primarily for desktop use but adaptable to various screen sizes to utilize available real estate effectively.

Development

This project uses many tools like:

• Vite
• ReactJS
• TypeScript
• Vitest
• Testing Library
• Tailwindcss
• Eslint
• Prettier

Getting Started

Install

Access the project directory.

cd my-app

Install dependencies.

npm install

Serve with hot reload at http://localhost:5173.

npm run dev

Lint

npm run lint

Typecheck

npm run typecheck

Build

npm run build

Test

npm run test

View and interact with your tests via UI.

npm run test:ui

License

This project is licensed under the AGPL-3.0 License - see the LICENSE file for details.