Skip to content

INSTALL.md

Latest commit

 

History

History
105 lines (86 loc) · 1.6 KB

INSTALL.md

File metadata and controls

105 lines (86 loc) · 1.6 KB

Pixly Quick Start Guide

A guide to setup Pixly in your desktop.

📋 Prerequisites

🐍 Python 3.11+

python --version

🪟 Windows 10/11

node --version

⚡ uv Package Manager

pip install uv

🔧 Git

git --version

Quick Setup

  1. Clone the repository :
git clone https://github.com/MLSAKIIT/pixly.git
cd pixly
  1. Open a powershell terminal as administrator and run the setup.bat file.
.\setup.bat

Manual Setup

  1. Clone the repository :
git clone https://github.com/MLSAKIIT/pixly.git
cd pixly
  1. Install uv package manager
pip install uv
# or
curl -LsSf https://astral.sh/uv/install.sh | sh
  1. Install dependencies
uv sync
  1. Set up environment variables :
    1. Visit Google AI Studio
    2. Create a new API key
    3. Add to .env:
GEMINI_API_KEY=your_gemini_key_here

  1. Make a folder called vector_db

  2. Start the application, Create two powershell terminals

Terminal 1 - Start Backend:

uv run run.py

Wait for the backend to start then in Terminal 2 - Start Frontend:

uv run overlay.py

Debugging

To test the various parts of the backend pipeline :

  1. Start the server in Terminal 1 :
uv run run.py
  1. Start the test script in Terminal 2 :
uv run test_system.py