Skip to content

Add .bat files for easier installation on windows and Update readme.md #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add .bat files for easier installation on windows and Update readme.md #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
53d0031
Add bat files for windows users
Nischay-VideoDB Nov 7, 2025
7b990a5
Add proper npm dependencies installation
Nischay-VideoDB Nov 7, 2025
548bd14
Add patch-package guard in setup and frontend bat files, Add table of…
Nischay-VideoDB Nov 7, 2025
aada5a0
Add automate env update and port selection
Nischay-VideoDB Nov 7, 2025
373249a
Fix echo dot error in frontend bat file
Nischay-VideoDB Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 64 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,20 @@

<!-- ABOUT THE PROJECT -->

## 🧐 What is The Director?
## 📚 Table of Contents
- [🧐 What is The Director?](#what-is-the-director)
- [⭐️ Key Features](#key-features)
- [😎 Agent Examples](#agent-examples)
- [⚙️ Architecture Overview](#architecture-overview)
- [🧠 Reasoning Engine](#reasoning-engine)
- [🏃 Getting Started](#getting-started)
- [🚀 Running the Application](#running-the-application)
- [📘 Creating a New Agent](#creating-a-new-agent)
- [📖 Documentation](#documentation)
- [🤝 Contributing](#contributing)

<a id="what-is-the-director"></a>
## 🧐 What is The Director?

Think of Director as ChatGPT for videos. It is a framework to build video agents that can reason through complex video tasks like search, editing, compilation, generation etc & instantly stream the results.

Expand All @@ -72,6 +85,7 @@ https://github.com/user-attachments/assets/33e0e7b4-9eb2-4a26-8274-f96c2c1c3a48

<br/>

<a id="key-features"></a>
## ⭐️ Key Features
### 🤖 20+ pre-built video agents that you can customize to
* Summarize videos in seconds.
Expand All @@ -95,12 +109,14 @@ Easily add new agents and tools to your workflow. Whether you want to run it loc

<br/>

<a id="agent-examples"></a>
## 😎 Agent Examples

1. Highlight Creator: [link](https://www.youtube.com/watch?v=Dncn_0RWrro&list=PLhxAMFLSSK039xl1UgcZmoFLnb-qNRYQw&index=11)
2. Text to Movie: [link](https://www.youtube.com/watch?v=QpnRxuEBDCc&list=PLhxAMFLSSK039xl1UgcZmoFLnb-qNRYQw&index=2)
3. Video Search: [link](https://www.youtube.com/watch?v=kCiCI2KCnC8&list=PLhxAMFLSSK039xl1UgcZmoFLnb-qNRYQw&index=4)

<a id="architecture-overview"></a>
## ⚙️ Architecture Overview
Director's architecture brings together:

Expand All @@ -111,7 +127,8 @@ Director's architecture brings together:

![Director architecture](https://github.com/user-attachments/assets/9afb2783-66db-4899-9308-03cbd12e74d7)

## 🧠 **Reasoning Engine**
<a id="reasoning-engine"></a>
## 🧠 Reasoning Engine

At the heart of The Director is its **Reasoning Engine**, a powerful core that drives intelligent decision-making and dynamic workflows. It acts as the brain behind the agents, enabling them to process commands, interact with data, and deliver meaningful outputs.

Expand All @@ -135,67 +152,91 @@ For a closer look, check out the detailed architecture diagram below:



<a id="getting-started"></a>
## 🏃 Getting Started

### Prerequisites

- Python 3.9 or higher
- Node.js 22.8.0 or higher
- npm
- **Python 3.9 or higher**
- **Node.js 22.8.0 or higher**
- **npm**

### Installation

**1. Clone the repository:**

``` bash
```bash
git clone https://github.com/video-db/Director.git
cd Director
```

**2. Run the setup script:**

**For Mac/Linux:**
```bash
./setup.sh
```

**For Windows:**
```cmd
setup.bat
```

> This script will:
> - Install Node.js 22.8.0 using nvm
> - Install Node.js 22.8.0 using nvm (Mac/Linux)
> - Verify Python 3.9+ and Node.js 22.8.0+ are installed (Windows)
> - Install Python and pip
> - Set up virtual environments for both frontend and backend.


> - Set up virtual environments for both frontend and backend

Comment on lines +186 to 190
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Clarify what setup.bat actually installs.

setup.bat exits if Python is missing on Windows; it never installs Python or pip. Leaving this bullet as-is sets the wrong expectation and ships misleading setup docs.

Apply this diff to reflect the real behavior:

-> - Install Python and pip
+> - Install backend Python dependencies inside a virtual environment
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> - Install Node.js 22.8.0 using nvm (Mac/Linux)
> - Verify Python 3.9+ and Node.js 22.8.0+ are installed (Windows)
> - Install Python and pip
> - Set up virtual environments for both frontend and backend.
> - Set up virtual environments for both frontend and backend
> - Install Node.js 22.8.0 using nvm (Mac/Linux)
> - Verify Python 3.9+ and Node.js 22.8.0+ are installed (Windows)
> - Install backend Python dependencies inside a virtual environment
> - Set up virtual environments for both frontend and backend
🤖 Prompt for AI Agents 
In README.md around lines 186-190, the docs misleadingly imply setup.bat
installs Python and pip; instead update the bullets to state that setup.bat only
checks for Python on Windows and will exit if it is missing (it does not install
Python or pip), replace "Install Python and pip" with "Ensure Python 3.9+ and
pip are installed (install manually if missing)" and clarify that Windows
instructions verify Python/Node versions but that Python must be installed by
the user before running setup.bat.

**3. Configure the environment variables:**

Edit the `.env` files to add your API keys and other configuration options.

### Supported platforms:
- Mac
- Linux
- Windows (WSL)
Get your free VideoDB API key from [console.videodb.io](https://console.videodb.io/)

## 💬 Running the Application
### Supported Platforms
- ✅ **Mac**
- ✅ **Linux**
- ✅ **Windows** (native)
- ✅ **Windows (WSL)**

To start both the backend and frontend servers:
---

<a id="running-the-application"></a>
## 🚀 Running the Application

**For Mac/Linux:**

To start both the backend and frontend servers:
```bash
make run
```

- Backend: `http://127.0.0.1:8000`

- Frontend: `http://127.0.0.1:8080`

For specific tasks:

**For specific tasks:**
- Backend only: `make run-be`

- Frontend only: `make run-fe`

**For Windows:**

To start both servers:
```cmd
start-all.bat
```

This will open two windows (backend and frontend). The application will be available at:
- Backend: `http://127.0.0.1:8000`
- Frontend: `http://127.0.0.1:8080`

**For specific tasks:**
- Backend only: `start-backend.bat`
- Frontend only: `start-frontend.bat`

<!-- CONTRIBUTING -->
---

<a id="creating-a-new-agent"></a>
## 📘 Creating a New Agent

> Checkout hosted documentation at https://docs.director.videodb.io
Expand Down Expand Up @@ -234,6 +275,7 @@ Duplicate `sample_agent.py` in `Director/backend/director/agents/` and rename it
Remember to consider creating reusable tools if your agent's functionality could be shared across multiple agents.


<a id="documentation"></a>
## 📖 Documentation
> Checkout hosted documentation at https://docs.director.videodb.io
### Serve Locally
Expand All @@ -253,6 +295,7 @@ mkdocs build



<a id="contributing"></a>
## 🤝 Contributing

We welcome integrations from projects that can make video workflows easy and increase capabilities of the projects. Please check issues and discussions for details.
Expand Down
Loading