Skip to content

setup.md

Latest commit

 

History

History
66 lines (54 loc) · 1.77 KB

setup.md

File metadata and controls

66 lines (54 loc) · 1.77 KB

🛠 Installation & Setup Guide

This guide provides detailed instructions on how to set up the environment and run the FrameFlow application.

🚀 Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • Google Gemini API Key (Google AI Studio) — Ask us if you need an API key to test this project.

🛠 External Tool Setup

The application relies on FFmpeg for video processing and PySceneDetect for scene analysis.

🍏 macOS

  1. FFmpeg: Install via Homebrew: 
    brew install ffmpeg
  2. PySceneDetect: Install via pip (requires Python): 
    pip install scenedetect

🪟 Windows

  1. Chocolatey: Ensure Chocolatey is installed to manage packages.
  2. FFmpeg: Install via terminal (Run as Administrator): 
    choco install ffmpeg
  3. PySceneDetect: There are two options to install PySceneDetect:
    1. (Python Package Option):
      • Ensure Python is installed and added to PATH.
      • Install via terminal: 
        pip install scenedetect
    2. PySceneDetect (Windows Installer):
      • Download the installer from PySceneDetect Download.
      • Run the installer and follow the instructions.
      • You might need to install open-cv as well: 
        pip install opencv-python

💻 Installation

  1. Clone the repository:

    git clone https://github.com/navidshad/frameflow.git
cd frameflow

  2. Install dependencies:

    yarn install

  3. Start the application:

    yarn dev