Dev

.github/workflows/actions.yml

@@ -56,17 +56,21 @@ jobs:
 
       - name: Install Python dependencies
         run: |
+          # Install CPU only PyTorch
+          pip install torch --index-url https://download.pytorch.org/whl/cpu
+
           pip install \
             pytest \
             python-magic \
             mutagen \
-            pypdf \
+            pyMuPDF \
             python-docx \
             Pillow \
             pymediainfo \
             yake \
             scikit-learn \
             sentence-transformers \
+            nltk \
             grpcio \
             grpcio-tools
 
@@ -108,16 +112,18 @@ jobs:
         working-directory: ./app
         run: flutter test --reporter=expanded
 
+      # Important linting note: We fix most linting errors ourselves before merging to main. The linting errors remaining are ignored as they are unsafe to fix automatically
       - name: Run Python linter
         run: |
           pip install flake8
           echo "Running flake8 linter (will not fail the build)..."
           flake8 python/src || echo "flake8 finished with errors, but continuing build."
 
       - name: Run Go linter
+        working-directory: ./golang
         run: |
           go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
-          golangci-lint run ./golang/... || true
+          golangci-lint run ./filesystem/... || true
 
       - name: Run Flutter analyzer
         working-directory: ./app

.gitignore

@@ -18,3 +18,18 @@ venv/
 message_structure.pb.go
 message_structure_grpc.pb.go
 
+app/windows/flutter/generated_plugins.cmake
+app/windows/flutter/generated_plugin_registrant.cc
+app/macos/Flutter/GeneratedPluginRegistrant.swift
+app/linux/flutter/generated_plugins.cmake
+app/linux/flutter/generated_plugin_registrant.cc
+app/pubspec.lock
+
+# Coverage
+.coverage
+profiling/
+
+# swap files
+*.swp
+
+/golang/storage/*

README.md

@@ -3,7 +3,7 @@
 </p>
 
 <p align="center">
-Smart File Manager (SFM) is a digital housekeeper that uses metadata, natural language processing, and AI clustering algorithms to automate file management. SFM can perform smart context searches, navigate directories with an intuitive graph view, and perform smart context searches for important files. It's a versatile AI file finder and a new best friend for modern computer users.
+Smart File Manager (SFM) is a digital housekeeper that uses metadata, natural language processing, and AI clustering algorithms to automate file management. SFM can perform smart context searches, navigate directories with an intuitive graph view, and automatically sort your files for you. It's a versatile AI file finder and a new best friend for modern computer users.
 </p>
 
 <div align="center">
@@ -27,10 +27,17 @@ Smart File Manager (SFM) is a digital housekeeper that uses metadata, natural la
 - [🌳 Branching Strategy](#-branching-strategy)
 - [✔️ Quality Badges](#️-quality-badges)
 
+## 📩 Get our installer here
+- [link to our installer](https://drive.google.com/drive/folders/1KlQ3yYhmHYFbv0vVpLBJv5CjVyD5idO4?usp=drive_link)
+
 ## 🎥 Demo Videos
 
 - [Demo 1 Video](https://drive.google.com/file/d/13_amEyoW3bTHRSY3giBA2xw_4UlJE3Eq/view?usp=sharing)
 
+- [Demo 2 Video](https://drive.google.com/file/d/1r3b0Cgn8EPdx442N7hdfmTc4ODt7TX4g/view?usp=drive_link)
+
+- [Demo 3 Video]()
+
 ## 📑 Documentation
 
 <details>
@@ -57,6 +64,20 @@ Smart File Manager (SFM) is a digital housekeeper that uses metadata, natural la
 
 </details>
 
+<details>
+<summary><strong>📋 Demo 3 Documentation</strong></summary>
+
+🔗 [Functional Requirements Document (SRS)](docs/documentation/demo_3/srs.md) <br>
+🔗 [Architectural Specifications](docs/documentation/demo_3/Architecture.md) <br>
+🔗 [Wireframe Documentation](docs/documentation/demo_3/wireframe.md) <br>
+🔗 [Research Document](docs/documentation/demo_3/researchDoc.md) <br>
+🔗 [User Manual](docs/documentation/demo_3/user_manual.md) <br>
+🔗 [Coding Standards](docs/documentation/demo_3/coding_standards.md) <br>
+🔗 [Technical Installation Manual](docs/documentation/demo_3/technical_installation.md) <br>
+🔗 [User Manual](docs/documentation/demo_3/user_manual.md) <br>
+
+</details>
+
 ## 📊 Project Board
 
 The GitHub Project boards are used to track current tasks allocated to each team member, facilitating effective communication, progress monitoring, and ensuring we meet project deadlines while maintaining accountability and transparency throughout the development process.
@@ -74,7 +95,7 @@ The GitHub Project boards are used to track current tasks allocated to each team
   <tr>
     <td width="30%">
       <strong>Jack Bawden</strong><br>
-      <img src="docs/documentation/demo_2/assets/readmeAssets/Jack.jpg" width="100%" height="300">
+      <img src="docs/documentation/demo_3/assets/readmeAssets/Jack.jpg" width="100%" height="300">
     </td>
     <td width="20%">
       <code>Golang & Python</code><br>
@@ -89,7 +110,7 @@ The GitHub Project boards are used to track current tasks allocated to each team
   <tr>
     <td width="30%">
       <strong>Philipp du Plessis</strong><br>
-      <img src="docs/documentation/demo_2/assets/readmeAssets/philipp.jpg" width="100%" height="300">
+      <img src="docs/documentation/demo_3/assets/readmeAssets/philipp.jpg" width="100%" height="300">
     </td>
     <td width="20%">
       <code>Golang & Python</code><br>
@@ -104,7 +125,7 @@ The GitHub Project boards are used to track current tasks allocated to each team
   <tr>
     <td width="30%">
       <strong>Tiaan Bosman</strong><br>
-      <img src="docs/documentation/demo_2/assets/readmeAssets/tiaan.jpeg" width="100%" height="300">
+      <img src="docs/documentation/demo_3/assets/readmeAssets/tiaan.jpeg" width="100%" height="300">
     </td>
     <td width="20%">
       <code>UX & UI Developer</code><br>
@@ -120,7 +141,7 @@ The GitHub Project boards are used to track current tasks allocated to each team
   <tr>
     <td width="30%">
       <strong>Henco Pretorius</strong><br>
-      <img src="docs/documentation/demo_2/assets/readmeAssets/Henco.jpg" width="100%" height="300">
+      <img src="docs/documentation/demo_3/assets/readmeAssets/Henco.jpg" width="100%" height="300">
     </td>
     <td width="20%">
       <code>Golang & Python</code><br>
@@ -135,7 +156,7 @@ The GitHub Project boards are used to track current tasks allocated to each team
   <tr>
     <td width="30%">
       <strong>Dewald Colesky</strong><br>
-      <img src="docs/documentation/demo_2/assets/readmeAssets/dewald.JPG" width="100%" height="300">
+      <img src="docs/documentation/demo_3/assets/readmeAssets/dewald.JPG" width="100%" height="300">
     </td>
     <td width="20%">
       <code>Backend Legend</code><br>

app/.gitignore

@@ -43,3 +43,6 @@ app.*.map.json
 /android/app/debug
 /android/app/profile
 /android/app/release
+
+pubspec.lock
+