From 0901d287608a83f0ab6ec71cff5a907a86bce320 Mon Sep 17 00:00:00 2001 From: VasuS609 Date: Thu, 26 Feb 2026 16:15:52 +0530 Subject: [PATCH] docs: update README social links --- README.md | 131 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 95 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 595889480..56ba1af6f 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,76 @@ -# PictoPy + +
+ + +
+ + AOSSIE Logo + +
+ +  + + +
+ +[![Static Badge](https://img.shields.io/badge/aossie.org/PictoPy-228B22?style=for-the-badge&labelColor=FFC517)](https://aossie.org/) + +
+ + +

+ + + Email + + + +Telegram Badge +   + + +X (formerly Twitter) Badge +   + + +Discord Badge +   + + + Medium Badge +   + + + LinkedIn Badge +   + + + Youtube Badge +

-PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust for the frontend with a Python backend for sophisticated image analysis and management. - -# Want to Contribute? 😄 - -    - -1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn) (Go to Projects->PictoPy)** to chat with everyone. -2. For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file. - -# Architecture - -### Frontend - -- **Tauri**: Enables building the desktop application -- **React**: Used for creating the user interface -- **Rust**: Powers the backend, which the frontend communicates with through Tauri's API +--- -### Backend (Python) +
+

PictoPy

+
-- **FastAPI**: Serves as the API framework -- **SQLite**: Database for storing metadata and embeddings -- **YOLO**: Used for object detection -- **FaceNet**: Generates face embeddings -- **ONNX Runtime**: Runs the models efficiently -- **DBSCAN**: Performs clustering for face embeddings +PictoPy is an advanced desktop gallery application that combines the power of **Tauri**, **React**, and **Rust** for the frontend with a **Python** backend for sophisticated image analysis and management. It offers efficient data handling, parallel processing, and a privacy-focused design that keeps your data entirely offline. -### Backend (Rust via Tauri) +--- -Handles file system operations and provides a secure bridge between the frontend and local system. +## 🚀 Features -## Features +- **Smart Tagging**: Automatic tagging of photos based on detected objects, faces, and their recognition. +- **Album Management**: Traditional gallery features for organizing and managing photo albums. +- **Advanced Image Analysis**: Object detection and facial recognition powered by YOLO and FaceNet. +- **Privacy-Focused**: Fully offline functionality keeping your data on your device. +- **Smart Search & Retrieval**: Efficient search across your photo library. +- **Performance**: Efficient data handling and parallel processing for smooth operations. +- **Cross-Platform**: Compatible across major desktop operating systems. -- Smart tagging of photos based on detected objects, faces, and their recognition -- Traditional gallery features of album management -- Advanced image analysis with object detection and facial recognition -- Privacy-focused design with offline functionality -- Efficient data handling and parallel processing -- Smart search and retrieval -- Cross-platform compatibility +--- -## Technical Stack +## 💻 Tech Stack | Component | Technology | | ----------------- | -------------------- | @@ -52,6 +82,7 @@ Handles file system operations and provides a secure bridge between the frontend | Image Processing | OpenCV, ONNX Runtime | | Object Detection | YOLOv11 | | Face Recognition | FaceNet | +| Clustering | DBSCAN | | API Framework | FastAPI | | State Management | Redux Toolkit | | Styling | Tailwind CSS | @@ -62,4 +93,32 @@ Handles file system operations and provides a secure bridge between the frontend --- -Our Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) +## 🏗️ Architecture + +### Frontend +- **Tauri**: Enables building the secure, lightweight desktop application. +- **React**: Used for creating the dynamic user interface. +- **Rust**: Powers the system-level backend, which the frontend communicates with through Tauri's API. + +### Backend (Python) +- **FastAPI**: Serves as the high-performance API framework. +- **SQLite**: Database for storing metadata and embeddings. +- **YOLO**: Used for precise object detection. +- **FaceNet**: Generates face embeddings for recognition. +- **ONNX Runtime**: Runs the ML models efficiently. +- **DBSCAN**: Performs clustering for face embeddings to group similar faces. + +### Backend (Rust via Tauri) +Handles file system operations and provides a secure bridge between the frontend and the local system. + +--- + +## 🔗 Repository Links + +1. [Main Repository](https://github.com/AOSSIE-Org/PictoPy) +2. [Frontend](https://github.com/AOSSIE-Org/PictoPy/tree/main/frontend) +3. [Backend](https://github.com/AOSSIE-Org/PictoPy/tree/main/backend) + +--- +Copyright (C) 2026 AOSSIE (Australian Open Source Software Innovation and Education) +