Skip to content

This repository contains source code for the backend of a screen recording browser extension which takes in video blobs in chunks or whole, concatenates, saves, encodes into audio and transcribes them into text.

Notifications You must be signed in to change notification settings

DimTony/ScreenRecExtension-HNGtask5

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Screen Recording Chrome Extension API

This Node.js API allows you to perform video processing tasks, including uploading video chunks, concatenating videos, and transcribing the concatenated.

1. Features

  • Upload video chunks.
  • Concatenate uploaded video chunks.
  • Transcribe the concatenated video.
  • Retrieve video and transcription information.

2. Getting Started

Follow the steps below to set up and run the API.

3. Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js
  • npm (Node Package Manager)

4. Project Dependencies

  • Express
  • Body-parser
  • Path
  • Multer
  • Fluent-ffmpeg
  • Deepgram SDK
  • Fs
  • UUID
  • Dotenv

5. Installation

Clone This Repository:

  git clone https://github.com/DimTony/HNGtask5-Extension.git
  cd HNGtask5-Extension

Install Dependencies

  npm install

This installs the packages in the package.json file.

Configure the API

Create a .env file in the root directory and specify your environment variables, including your Deepgram API Key and preferred port

  • PORT= The port on which the API will run (default is 3000)
  • DEEPGRAM_API_KEY= The API Key to your Deepgram instance.

Sample:

PORT=3000
DEEPGRAM_API_KEY=YOUR_DEEPGRAM_API_KEY_HERE

6. Usage

Running the API

To start the API, run the following command:

npm start

The API will start and be available at http://localhost:3000 (or the port you specified in the .env file)

API Interactions

Use an API client (e.g., Postman) to interact with the following endpoints

  • Start Video: POST /api/start
  • Upload, Concatenate & Transcribe Video: POST /api/uploadFile
  • Retrieve Video Information: GET /api/getVideo/:id

Limitations

  • A good internet connection is required when running the API as it involves video manipulations.

Live URL

This API is hosted on Render at the following address: Live URL

7. Contributing

Contributions are welcomed! Feel free to open issues or submit pull requests or reach out through email via: MyEmail.

About

This repository contains source code for the backend of a screen recording browser extension which takes in video blobs in chunks or whole, concatenates, saves, encodes into audio and transcribes them into text.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published