Skip to content

Latest commit

 

History

History
245 lines (174 loc) · 5.32 KB

README.md

File metadata and controls

245 lines (174 loc) · 5.32 KB

🚀 Archi Query - Free Edition

Local document RAG query and organization system powered by Electron.

✨ Features (Free Version)

  • 📄 Import Documents - PDF, DOCX, TXT files
  • ðŸ“� Folder Import - Recursive scan and import
  • 💾 Database Export - Backup your data as JSON
  • 🗂ï¸� Local Storage - All data stored in SQLite (AppData)
  • ðŸ”� Document Search - Coming soon: RAG-powered queries
  • 📊 Organization - Coming soon: Auto-classification

🎯 Pro Features (Coming Soon)

  • ðŸŒ� Network Drive Support - Watch and import from shared folders
  • 👥 Team Collaboration - Shared database across machines
  • â˜�ï¸� Cloud Sync - Auto-backup to NAS/cloud storage
  • âš¡ Auto-Watch - Automatic import when files added

🛠� Development

Prerequisites

  • Node.js 18+
  • npm or yarn

Setup

# Install dependencies
npm install

# Run in development mode
npm run dev

# Build portable executable
npm run build:portable

Project Structure

archi-query-electron/
├── electron/
│   ├── main.ts              # Main process
│   ├── preload.ts           # IPC bridge
│   └── services/
│       ├── localStorage.ts  # SQLite storage
│       └── fileImport.ts    # File import logic
├── src/
│   ├── App.tsx              # React app
│   ├── components/
│   │   ├── DocumentManagement.tsx
│   │   └── DocumentList.tsx
│   └── types/
│       └── electron.d.ts    # TypeScript definitions
├── public/
│   └── index.html
├── package.json
├── vite.config.ts           # Vite + Electron config
└── README.md

📊 Data Storage

Free Version

All data is stored locally in:

Windows:

C:\Users\<username>\AppData\Local\archi-query-electron\
├── data\
│   └── archi-query.db       # SQLite database
└── documents\
    ├── imported\            # Copied files
    └── organized\           # Organized files

macOS (Future):

~/Library/Application Support/archi-query-electron/

Linux (Future):

~/.local/share/archi-query-electron/

🧪 Testing

Manual Test

  1. Run app: npm run dev
  2. Click "📄 Import Files"
  3. Select 5-10 PDF files
  4. Verify:
    • ✅ Files imported successfully
    • ✅ Document list populated
    • ✅ File count correct
  5. Click "💾 Export Database"
  6. Verify JSON file created

Database Verification

Check SQLite database:

# Windows
cd %LOCALAPPDATA%\archi-query-electron\data
dir archi-query.db

# Open with SQLite browser (optional)

🚀 Building

Portable Executable

npm run build:portable

Output: release/ArchiQuery-Free-Portable-1.0.0.exe

Installer (Future)

npm run build

� Troubleshooting

Issue: "Cannot find module"

npm install
npm rebuild better-sqlite3

Issue: Window doesn't open

Check console for errors:

  • Open DevTools: Ctrl+Shift+I
  • Check main process logs in terminal

Issue: Import fails

  • Check file permissions
  • Try smaller files first
  • Check console for specific error

Issue: Database locked

  • Close all app instances
  • Delete %LOCALAPPDATA%\archi-query-electron\data\ to reset

� License

MIT

👨�💻 Author

Khogao

🎯 Roadmap

Phase 1: ✅ Foundation (CURRENT)

  • Electron boilerplate
  • Local storage (SQLite)
  • File import (manual)
  • Document list UI
  • Export/backup

Phase 2: 🔄 RAG Engine (Next)

  • Integrate LM Studio
  • Embedding generation
  • Vector storage
  • Query interface
  • Search results UI

Phase 3: 📅 Organization

  • Auto-classification
  • Batch operations
  • Folder structure
  • Undo/redo

Phase 4: 💎 Pro Version

  • Network drive support
  • Auto-watch folders
  • Multi-PC sync
  • Team collaboration

Status: ✅ Prototype Ready!

Next: Test import → Integrate RAG → Ship it! 🚀

Multi-Machine Sync Setup

This repository is part of the Khogao Coding Workspace synchronized across 3 machines (Windows, macOS, Linux Mint).

Quick Sync Instructions

Windows (PowerShell)

cd D:\Work\Coding
git clone https://github.com/Khogao/archi-query-electron.git
code archi-query-electron

macOS / Linux

cd ~/Work/Coding
git clone https://github.com/Khogao/archi-query-electron.git
code archi-query-electron

Daily Workflow

  1. Morning: Pull latest changes
  2. Work: Edit, commit, push
  3. Evening: Verify all pushed

See CLOUD_WORKSPACE_SETUP.md and SUPREME_YOLO_GUIDELINES.md for details.