Merge pull request #421 from rahulharpal1603/enhancement/setup-guide-update

Introduce Video Tutorials for Setup and Change README.md  Setup Instructions [Sr. No. 26]

Author: Pranav0-0Aggarwal

README.md

@@ -1,5 +1,7 @@
 # PictoPy
 
+### Discord Channel [Link](https://discord.com/channels/1022871757289422898/1311271974630330388)
+
 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.
 
 ## Architecture
@@ -55,76 +57,49 @@ Handles file system operations and provides a secure bridge between the frontend
 
 ## Setup
 
-### Frontend Setup
+1. Setup Using Script (Recommended Approach): [Guide](docs/Script_Setup_Guide.md)
+2. Setup Manually: [Guide](docs/Manual_Setup_Guide.md)
+3. Docker Setup:
 
-#### Prerequisites
+   - Docker Compose Setup: [Guide](./docs/docker-compose/redme.md)
+   - Setup using Dockerfile
 
-- Node.js (LTS version recommended)
-- npm (comes with Node.js)
-- Rust (latest stable version)
-- Tauri CLI
+     - For setting up the frontend, follow the instructions in the [Frontend Setup Guide](./docs/frontend/docker-setup.md).
+       </br>
+     - For setting up the backend, follow the instructions in the [Backend Setup Guide](./docs/backend/docker-setup.md).
 
-#### Installation
+## Testing
 
-1. Clone the repository to your local system:
+### Frontend
 
-## Automatic Setup:
-```bash
-npm run setup
-```
-   ```bash
-   git clone git@github.com:AOSSIE-Org/PictoPy.git
-   ```
-
-   ```bash
-   cd PictoPy
-   ```
-   
-## Automatic Setup:
 ```bash
-npm run setup
+cd frontend
+npm test
 ```
-## Manual Setup:
-1. Navigate to the frontend directory:
-   ```bash
-   cd frontend
-   ```
-1. Install dependencies:
 
-   ```bash
-   npm install
-   ```
+### Backend
 
-   ```bash
-    cd scripts
-   ```
-
-   On Debian/Ubuntu:
-
-   ```bash
-   ./setup_env.sh
-   ```
-
-   On Windows:
-   ```
-   ./setup_win.ps1
-   ```
-
-#### Running the Application
+- FastAPI
+  ```bash
+  cd backend
+  pytest
+  ```
+- Tauri
 
-```bash
-npm run tauri dev
-```
+  ```bash
+  cd frontend/src-tauri/
+  cargo test
+  ```
 
-#### Building for Production
+## Building for Production
 
 Create Signing Keys for tauri using the command:
 
 ```bash
 npm run tauri signer generate
 ```
 
-Set the public key in tauri.conf.json as pubkey and private key and password in Enviroment Variables as TAURI_SIGNING_PRIVATE_KEY and TAURI_SIGNING_PRIVATE_KEY_PASSWORD
+Set the public key in tauri.conf.json as pubkey and private key and password in Environment Variables as TAURI_SIGNING_PRIVATE_KEY and TAURI_SIGNING_PRIVATE_KEY_PASSWORD
 
 There is a preset pubkey in tauri.conf.json ; private key and password for it is:
 
@@ -140,138 +115,9 @@ TAURI_SIGNING_PRIVATE_KEY_PASSWORD=pass
 npm run tauri build
 ```
 
-### Python Backend Setup
-
-**Note:** For backend setup make sure that you have Python version 3.12 or lower. Additionally, for Windows, make sure that you are using powershell for the setup, not command prompt.
-
-#### Installation Steps
-
-1.  **Navigate to the Backend Directory:** Open your terminal and use `cd` to change directories:
-
-    Bash
-
-    ```
-    cd backend
-
-    ```
-
-2.  **Set Up a Virtual Environment (Highly Recommended):** Virtual environments isolate project dependencies. Create one using:
-
-    Bash(Linux/MacOS)
-
-    ```
-    python3 -m venv .env
-
-    ```
-
-    Powershell(Windows)
-
-    ```
-    python -m venv .env
-
-    ```
-
-3.  **Activate the Virtual Environment:**
-
-    Bash(Linux/MacOS)
-
-    ```
-    source .env/bin/activate
-
-    ```
-
-    Powershell(Windows)
-
-    ```
-    .env\Scripts\activate.ps1
-
-    ```
-
-    After activating, you should be able to see the virtual environment's name before the current path. Something like this:
-
-    ![alt text](docs/assets/screenshots/virtualEnv.png)
-
-4.  **Install Dependencies:** The `requirements.txt` file lists required packages. Install them using pip:
-
-    Bash
-
-    ```
-    pip install -r requirements.txt
-
-    ```
-
-5.  **Missing System Dependencies:** Some dependencies might need system-level libraries like `libGL.so.1` (often needed by OpenCV). Install the appropriate packages based on your distribution:
-
-    **Debian/Ubuntu:**
-
-    Bash
-
-    ```
-    sudo apt update
-    sudo apt install -y libglib2.0-dev libgl1-mesa-glx
-
-    ```
-
-    **Other Systems:** Consult your distribution's documentation for installation instructions.
-
-6.  **`gobject-2.0` Not Found Error:** Resolve this error by installing `libglib2.0-dev` (Debian/Ubuntu):
-
-    Bash
-
-    ```
-    sudo apt install -y libglib2.0-dev pkg-config
-
-    ```
-
-    For other systems, consult your distribution's documentation.
-
-7.  **Running the backend:**: To start the backend in development mode, run this command while being in the backend folder and the virtual environment activated:
-
-    Bash/Powershell
-
-    ```
-    fastapi dev
-    ```
-
-    The server will start on `http://localhost:8000` by default. In test mode, the server will automatically restart if any errors are detected or if source files are modified.
-
-    ![alt text](docs/assets/screenshots/serverRunning.png)
-
-### Docker Compose Setup
-
-- [Docker Compose](./docs/docker-compose/redme.md)
-
-### Setup using Dockerfile
-
-- For setting up the frontend, follow the instructions in the [Frontend Setup Guide](./docs/frontend/docker-setup.md).
-  </br>
-- For setting up the backend, follow the instructions in the [Backend Setup Guide](./docs/backend/docker-setup.md).
-
-### Testing
-
-#### Frontend
-
-```bash
-cd frontend
-npm test
-```
-
-#### Backend'
-
-- FastAPI
-  ```bash
-  cd backend
-  pytest
-  ```
-- Tauri
-  ```bash
-  cd frontend/src-tauri/
-  cargo test
-  ```
-
 ## Additional Resources
 
-- [Tauri Documentation](https://tauri.app/v1/guides/)
+- [Tauri Documentation](https://tauri.app/start/)
 - [React Documentation](https://reactjs.org/docs/getting-started.html)
 - [FastAPI Documentation](https://fastapi.tiangolo.com/)
 

app.py

@@ -8,11 +8,14 @@ def initialize_app():
     invalidate_cache()
     # ...existing code...
 
+
 # If there's a refresh functionality, update it to clear relevant caches
 def refresh_data():
     # ...existing code...
     # Clear specific caches that need refreshing
     invalidate_cache("albums:get_all_albums")
     invalidate_cache("folder_structure:get_folder_structure")
     # ...existing code...
+
+
 # ...existing code...