Skip to content

FrimpsManu/context_retrieval_system

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

ContextRetrieval

ContextRetrieval is an intelligent content search system that uses AI to help you quickly find and retrieve information across your digital workspace. Built with modern web technologies and featuring a beautiful, responsive interface.

Features

  • 🔍 AI-Powered Search: Advanced semantic understanding for more accurate and contextual search results
  • Real-Time Processing: Instant search with millisecond response times
  • 🔐 Enterprise Security: Bank-grade encryption and secure data handling
  • 🌙 Dark Mode Support: Beautiful dark mode interface for comfortable viewing
  • 🎯 Smart Results: Contextual previews and quick actions for search results
  • 🔊 Voice Search: Search using voice commands (browser support required)
  • 📱 Responsive Design: Works seamlessly across all devices and screen sizes

Tech Stack

  • Frontend: React, TypeScript, Tailwind CSS
  • Backend: Supabase (PostgreSQL, Auth, Vector Store)
  • AI/ML: Supabase Vector Embeddings
  • State Management: React Hooks
  • Animations: Framer Motion
  • Icons: Lucide React

Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • A Supabase account

Installation

  1. Clone the repository:

    git clone https://github.com/FrimpsManu/context_retrieval_system.git
    cd context_retrieval_system
  2. Install dependencies:

    npm install
  3. Create a .env file in the root directory:

    VITE_SUPABASE_URL=your_supabase_url
    VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
  4. Start the development server:

    npm run dev

Database Setup

The project uses Supabase for data storage and authentication. The database schema includes:

  • user_preferences: User settings and preferences
  • search_history: User search history
  • tab_data: Content data with vector embeddings

The migrations are located in the supabase/migrations directory.

Usage

  1. Sign up or log in to your account
  2. Use the search bar to find content using natural language
  3. Click on results to view full content
  4. Use keyboard shortcuts for quick navigation:
    • ⌘ + K: Focus search
    • ↑/↓: Navigate results
    • Enter: Open selected result
    • Esc: Clear search/Close modal
    • ?: Show keyboard shortcuts

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Contact

Project Link: https://github.com/FrimpsManu/context_retrieval_system

Releases

No releases published

Packages

 
 
 

Contributors