Skip to content

Getting Started

Prerequisites

  • Python 3.9 or higher
  • Node.js 22.8.0 or higher
  • npm

Installation

  1. Clone the repository:
git clone https://github.com/video-db/Director.git
cd Director
  1. Set up the environment:
./setup.sh

This script will: - Install nvm (Node Version Manager) if not already installed - Install Node.js 22.8.0 using nvm - Install Python and pip - Set up virtual environments for both frontend and backend - Install dependencies for both frontend and backend

Supported platforms: - Mac - Linux

  1. Configure the environment variables:
cp backend/.env.example backend/.env
cp frontend/.env.example frontend/.env

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

[TODO]: Add all supported variables or point to documentation where we have given the list.

  1. Initialize and configuring the Database

For SQLite (default): 

make init-sqlite-db

This command will initialize the SQLite DB file in the backend directory. No additional configuration is required for SQLite.

For other databases, follow the documentation here.

Project Structure

  • backend/: Contains the Flask backend application
  • frontend/: Contains the Vue 3 frontend application
  • docs/: Project documentation
  • infra/: Infrastructure-related files

Running the Application

To start both the backend and frontend servers:

make run

This will start the backend server on http://127.0.0.1:8000 and the frontend server on http://127.0.0.1:8080.

To run only the backend server:

make run-be

To just run the frontend development server:

make run-fe