Skip to content

Instantly share code, notes, and snippets.

@acidsound

acidsound/SnapFind.README.md

Created May 27, 2025 12:51
Show Gist options
  • Save acidsound/1338e614228077327830e95f681b969e to your computer and use it in GitHub Desktop.
Save acidsound/1338e614228077327830e95f681b969e to your computer and use it in GitHub Desktop.
Download ZIP
Raw
SnapFind.README.md

SnapFind - Smart Item Organizer

SnapFind is your personal digital assistant for effortlessly cataloging, finding, and managing your physical belongings. Simply snap a photo, add a few details, and let SnapFind's intelligent features help you keep everything organized. All your information is stored securely and privately in your browser's local database.

What Can SnapFind Do For You?

  • Effortless Item Cataloging:

    • Quick Add: Easily add new items with a description, where it's stored (location), and an optional image.
    • Versatile Image Upload: Add images by selecting files, dragging & dropping, or even pasting directly from your clipboard. Mobile users can choose from their photo gallery or take a new picture on the spot.
    • Smart Image Handling: Images are automatically resized and compressed on your device for efficient storage and faster processing, preventing issues with large files.

  • AI-Powered Organization:

    • Automatic Description Suggestion: Upload an image, and SnapFind's AI will instantly suggest a concise and relevant description for your item.
    • Intelligent Tag & Category Suggestions: Based on the item's image and description, SnapFind's AI proposes useful tags and categories. This helps you organize items logically and find them quickly later. You can trigger these suggestions when adding or editing an item.
    • Basic Tagging: If no image is provided, SnapFind generates simple tags from the item's description.
    • Duplicate Prevention: When adding an item with an image, SnapFind intelligently checks if it's very similar to an existing item (based on image and description). If a potential duplicate (90%+ similarity) is found, you'll be shown the existing item and asked to confirm before adding the new one, helping you avoid clutter.

  • Intuitive Item Management:

    • Clear Overview: View all your cataloged items in a clean, modern card layout. Each card displays the item's image, description, location, tags, and categories.
    • Easy Editing: Modify any detail of an existing item, including its image, description, location, and organizational tags/categories. Access the edit view via a dedicated icon on each item card.
    • AI Assistance During Edits: Re-trigger AI suggestions for description, tags, and categories anytime while editing an item.
    • Safe Deletion: Remove items you no longer need through the item editing view, with a confirmation step to prevent accidental deletions.

  • Powerful Search Capabilities:

    • Quick Access: A dedicated Floating Action Button (FAB) makes searching instantly accessible from your item list.
    • Text Search: Find items rapidly by typing keywords that match their description, location, tags, or categories.
    • Visual Search (Image-to-Text): Can't remember the details? Upload an image of an item, and SnapFind's AI will suggest relevant keywords (tags and categories) based on the image, helping you locate similar items in your collection.

  • Your Data, Your Control (Settings Page):

    • Private Local Storage: All your item data is stored privately and securely in your browser's IndexedDB. This means your data is accessible even offline and the app can handle a large collection of items smoothly.
    • Storage Insights: The application header provides an estimate of your browser's available storage capacity, so you know how much space you're using.
    • Fresh Start (Initialize): Need to start over? You can reset the application by clearing all items from your local database after a confirmation.
    • Backup Your Data (Export): Download your entire item catalog as a JSON file (e.g., YYYYMMDD_HHmmss.snap). This file serves as a backup or a way to transfer your data.
    • Restore or Transfer (Import): Upload a .snap file to bring your items into SnapFind. You'll have two options:
      • Replace: Clear all current data before importing the new items.
      • Merge: Add new items from the file and update any existing items if their IDs match those in the imported file. A warning is provided about potential data overwrites for matching IDs during a merge.

  • Modern & User-Friendly Design:

    • Built with Next.js, React, and ShadCN UI components for a smooth, responsive, and aesthetically pleasing experience on any device.
    • Navigation is centered around your main item list, with page-like views for adding, editing, and searching, ensuring a seamless and intuitive workflow.

Enjoy organizing with SnapFind!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment