avorg/README.md

Video Organization App

This project consists of a backend API (FastAPI) and a frontend web application (React).

Getting Started

Follow these instructions to set up and run the project on your local machine.

Prerequisites

• Node.js (LTS version recommended)
• npm (comes with Node.js)
• Python 3.8+
• pip (comes with Python)

Backend Setup and Run

The backend is a FastAPI application.

1. Navigate to the backend directory:

   cd backend
   

2. Install Python dependencies: It's recommended to use a virtual environment.

   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
   pip install -r requirements.txt
   

3. Run the backend server:

   uvicorn main:app --host 0.0.0.0 --port 8000
   

   The backend server will be accessible at http://0.0.0.0:8000.

Frontend Setup and Run

The frontend is a React application built with Vite.

1. Navigate to the frontend directory:

   cd frontend
   

2. Install Node.js dependencies:

   npm install
   

3. Run the frontend development server:

   npm run dev -- --host
   

   The frontend development server will typically run on http://localhost:5173 (or another available port).

Project Structure

• backend/: Contains the FastAPI backend application.
• frontend/: Contains the React frontend application.
• test_videos/: Sample video files.
• screenshot/: Screenshots of the application.