Docs: Rust backend

Author: animeshchaudhri

docs/backend/api.md renamed to docs/backend/backend_python/api.md

@@ -1,13 +1,14 @@
-# Backend Setup
-
+# Python Backend Setup
 
 ## Setup Directory
+
 !!! note "Base Directory"
-    All commands executed below are with respect to the `backend/` directory
+All commands executed below are with respect to the `backend/` directory
 
 ### Installing requirments
 
 We suggest setting up a virtual environment and run the following command
+
 ```bash
 pip install -r requirements.txt
 ```
@@ -16,8 +17,8 @@ The entry point for backend is `main.py` , since PictoPy is built on top of Fast
 `.bat` and `.sh` formats.
 
 !!! note "UNIX Development"
-    For UNIX based systems, to run in development mode run
-    ```bash
+For UNIX based systems, to run in development mode run
+`bash
     ./run.sh --test
-    ```
+    `
 The backend should now be successfully running on port 8000 by default. To change this modify the start-up scripts.

docs/backend/database.md renamed to docs/backend/backend_python/database.md

@@ -0,0 +1,54 @@
+## API Documentation
+
+The Rust backend provides the following commands that can be invoked from the frontend:
+
+### 1. get_folders_with_images
+- **Description**: Retrieves folders containing images from a specified directory.
+- **Parameters**: 
+  - `directory`: String
+- **Returns**: `Vec<PathBuf>`
+
+### 2. get_images_in_folder
+- **Description**: Gets all images in a specific folder.
+- **Parameters**: 
+  - `folder_path`: String
+- **Returns**: `Vec<PathBuf>`
+
+### 3. get_all_images_with_cache
+- **Description**: Retrieves all images, organized by year and month, with caching.
+- **Parameters**: 
+  - `directory`: String
+- **Returns**: `Result<HashMap<u32, HashMap<u32, Vec<String>>>, String>`
+
+### 4. get_all_videos_with_cache
+- **Description**: Retrieves all videos, organized by year and month, with caching.
+- **Parameters**: 
+  - `directory`: String
+- **Returns**: `Result<HashMap<u32, HashMap<u32, Vec<String>>>, String>`
+
+### 5. delete_cache
+- **Description**: Deletes all cached data.
+- **Parameters**: None
+- **Returns**: `bool`
+
+## Usage Example
+
+```javascript
+// In your frontend JavaScript/TypeScript code:
+import { invoke } from '@tauri-apps/api/tauri';
+
+// Example: Get all images with cache
+const imagesData = await invoke('get_all_images_with_cache', { directory: '/path/to/images' });
+
+// Example: Delete cache
+const cacheDeleted = await invoke('delete_cache');
+```
+
+## Key Components
+
+- **FileService**: Handles file system operations for images and videos.
+- **CacheService**: Manages caching of folders, images, and videos.
+- **FileRepository**: Interacts directly with the file system to retrieve file information.
+- **CacheRepository**: Handles reading from and writing to cache files.
+
+This backend architecture provides efficient file management and caching capabilities, enhancing the performance of image and video retrieval operations in the Tauri application.

docs/backend/directory-structure.md renamed to docs/backend/backend_python/directory-structure.md

@@ -0,0 +1,49 @@
+# Rust Backend Setup
+
+## Prerequisites
+
+Before setting up the frontend, ensure you have the following installed:
+
+- [Node.js](https://nodejs.org/) (LTS version recommended)
+- npm (comes with Node.js)
+- [Rust](https://www.rust-lang.org/tools/install) (latest stable version)
+- [Tauri CLI](https://v2.tauri.app/start/prerequisites/)
+
+For a comprehensive guide on prerequisites, refer to the [Tauri Prerequisites](https://v2.tauri.app/start/prerequisites/) documentation.
+
+## Setup Directory
+
+!!! note "Base Directory"
+    All commands executed below are with respect to the `frontend/` directory
+
+### Installing Dependencies
+
+1. Navigate to the frontend directory:
+   ```bash
+   cd frontend
+   ```
+
+2. Install the project dependencies:
+   ```bash
+   npm install
+   ```
+
+For more information on npm commands, see the [npm documentation](https://docs.npmjs.com/).
+
+## Running the Application
+
+To start the Tauri application in development mode, run:
+
+```bash
+npm run tauri dev
+```
+
+This command will:
+- Start the [Vite](https://vitejs.dev/) development server for the frontend
+- Compile the Rust backend
+- Launch the Tauri application window
+
+For more details on Tauri commands, check the [Tauri CLI documentation](https://tauri.app/v1/api/cli).
+
+!!! note "First Run"
+    The first run might take longer as it needs to compile the Rust code.

docs/backend/image-processing.md renamed to docs/backend/backend_python/image-processing.md

@@ -7,11 +7,10 @@ PictoPy is a modern desktop app designed to transform the handling of digital ph
     <img src="assets/AOSSIE-logo.png" alt="AOSSIE Logo" style="display:flex; margin:0 auto; justify-content: center;">
 </div>
 
-This project was announced by [AOSSIE](https://aossie.org/), an umbrella organization and was to be implemented from scratch. It provides features such as object detection and face similarity,
-offering smart tagging capabilities for photos based on objects, faces.
+This project was announced by [AOSSIE](https://aossie.org/), an umbrella organization and was to be implemented from scratch. It provides features such as object detection and face similarity, offering smart tagging capabilities for photos based on objects, faces.
 
 <div style="display:flex; margin:0 auto; justify-content: center;">
-    <div style="width:33%">
+    <div style="width:25%">
         <h2>Overview</h2>
         <ul>
             <li><a href='./overview/features'>
@@ -24,37 +23,52 @@ offering smart tagging capabilities for photos based on objects, faces.
             </li>
         </ul>
     </div>
-    <div style="width:33%">
-        <h2>Backend</h2>
+    <div style="width:25%">
+        <h2>Backend Python</h2>
         <ul>
             <li>
-                <a href="./backend/setup">
+                <a href="./backend/backend_python/setup">
                     Setup
                 </a>
             </li>
             <li>
-                <a href="./backend/database">
+                <a href="./backend/backend_python/database">
                     Database
                 </a>
             </li>
             <li>
-                <a href="./backend/directory-structure">
+                <a href="./backend/backend_python/directory-structure">
                     Directory Structure
                 </a>
             </li>
             <li>
-                <a href="./backend/api">
+                <a href="./backend/backend_python/api">
                     API
                 </a>
             </li>
             <li>
-                <a href="./backend/image-processing">
+                <a href="./backend/backend_python/image-processing">
                     Image Processing
                 </a>
             </li>
         </ul>
     </div>
-    <div style="width:33%">
+    <div style="width:25%">
+        <h2>Backend Rust</h2>
+        <ul>
+            <li>
+                <a href="./backend/backend_rust/setup">
+                    Setup
+                </a>
+            </li>
+            <li>
+                <a href="./backend/backend_rust/api">
+                    API
+                </a>
+            </li>
+        </ul>
+    </div>
+    <div style="width:25%">
         <h2>Frontend</h2>
         <ul>
             <li>
@@ -79,4 +93,4 @@ offering smart tagging capabilities for photos based on objects, faces.
             </li>
         </ul>
     </div>
-</div>
+</div>

docs/backend/setup.md renamed to docs/backend/backend_python/setup.md

@@ -1,7 +1,19 @@
 # Architecture
+
 ## Frontend
 
-## Backend
+For the frontend of our application, we use Tauri in combination with React. This allows us to create a desktop application with a web-based user interface. React handles the UI components and user interactions, while Tauri provides the bridge between our web-based frontend and Rust-based backend.
+
+Key points:
+
+- 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
+
+This combination allows us to leverage web technologies for the UI while benefiting from Rust's performance and security for core functionalities.
+
+## Backend Python
+
 <div style="text-align: center;">
     <img src="../../assets/backend-architecture.jpeg" alt="Backend Architecture" style="width: 80%; max-width: 600px; height: auto; display: block; margin: 0 auto;">
 </div>
@@ -11,10 +23,17 @@ For the backend, we rely on several techstack, our database is served on sqlite
 with FastAPI.  Our models are from various sources, we use YOLO models for object and face detection while we use FaceNet for generating the embeddings
 of the faces detected. All these models are run on ONNX runtime to avoid heavy dependancies, keeping the application light weight.
 
-
 We use DBSCAN algorithm to perform clustering for face embeddings generated. All of our database is in SQL (sqlite) and our API calls rely
 on queries from the backend.
 
 !!! note "Note"
-    We discuss all of the features and configuration of our application in further sections of the documentation. They can be used for both developers
-    as well as users who want to use the app. A postman collection has also been added which can be found in our API section.
+We discuss all of the features and configuration of our application in further sections of the documentation. They can be used for both developers
+as well as users who want to use the app. A postman collection has also been added which can be found in our API section.
+<br>
+<br>
+
+## Backend rust (via Tauri)
+
+The Rust backend, integrated through Tauri, is a core component of our application. It leverages Rust's performance and safety features to handle file system operations, provide a secure bridge between the frontend and the local system, and manage OS-level interactions. This backend efficiently manages tasks such as reading and writing image files, extracting metadata, and ensuring secure access to system resources. It communicates with the React frontend through an IPC mechanism, allowing for seamless integration of low-level functionalities with the user interface. This architecture enables high-performance, secure operations on the local system while maintaining a smooth user experience.
+
+

docs/backend/backend_rust/api.md

@@ -30,9 +30,18 @@
 
 | Component | Technology |
 | --------- | ---------- |
-| Backend | Python |
+| Frontend | React |
+| Desktop Framework | Tauri |
+| Rust Backend | Rust |
+| Python Backend | Python |
 | Database | SQLite |
 | Image Processing | OpenCV, ONNX Runtime |
 | Object Detection | YOLOv8 |
 | Face Recognition | FaceNet |
 | API Framework | FastAPI |
+| State Management | React Hooks |
+| Styling | Tailwind CSS |
+| Routing | React Router |
+| UI Components | Radix UI |
+| Build Tool | Vite |
+| Type Checking | TypeScript |