diff --git a/README.md b/README.md index a109eec..f325c83 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,10 @@ Smart File Manager (SFM) is a digital housekeeper that uses metadata, natural la ## 📄 Table of Contents +- [📄 Table of Contents](#-table-of-contents) +- [📩 Get our installer here](#-get-our-installer-here) - [🎥 Demo Videos](#-demo-videos) +- [Our website](#our-website) - [📑 Documentation](#-documentation) - [📊 Project Board](#-project-board) - [🤝 Team Profiles](#-team-profiles) @@ -38,7 +41,10 @@ Smart File Manager (SFM) is a digital housekeeper that uses metadata, natural la - [Demo 3 Video](https://drive.google.com/file/d/1k8QrDCzxmoQ0MvWkq4EAaTX5V6fvfJ1O/view?usp=sharing) -- [Demo 4 Video]() +- [Demo 4 Video](https://drive.google.com/file/d/1oBVasf6K1U3SB-TBgP_oUYYOF4qZcHMO/view?usp=drive_link) + +## Our website +Our website can be found at https://cos301-se-2025.github.io/Smart-File-Manager/ ## 📑 Documentation diff --git a/docs/documentation/demo_4/assets/userTests/ease_of_use.png b/docs/documentation/demo_4/assets/userTests/ease_of_use.png new file mode 100644 index 0000000..6533838 Binary files /dev/null and b/docs/documentation/demo_4/assets/userTests/ease_of_use.png differ diff --git a/docs/documentation/demo_4/assets/userTests/load_times.png b/docs/documentation/demo_4/assets/userTests/load_times.png new file mode 100644 index 0000000..7b038b3 Binary files /dev/null and b/docs/documentation/demo_4/assets/userTests/load_times.png differ diff --git a/docs/documentation/demo_4/assets/userTests/open_ended.png b/docs/documentation/demo_4/assets/userTests/open_ended.png new file mode 100644 index 0000000..de5de41 Binary files /dev/null and b/docs/documentation/demo_4/assets/userTests/open_ended.png differ diff --git a/docs/documentation/demo_4/assets/userTests/preference.png b/docs/documentation/demo_4/assets/userTests/preference.png new file mode 100644 index 0000000..87d8ea9 Binary files /dev/null and b/docs/documentation/demo_4/assets/userTests/preference.png differ diff --git a/docs/documentation/demo_4/assets/userTests/search.png b/docs/documentation/demo_4/assets/userTests/search.png new file mode 100644 index 0000000..de06f8a Binary files /dev/null and b/docs/documentation/demo_4/assets/userTests/search.png differ diff --git a/docs/documentation/demo_4/assets/userTests/settings_change.png b/docs/documentation/demo_4/assets/userTests/settings_change.png new file mode 100644 index 0000000..74bc78d Binary files /dev/null and b/docs/documentation/demo_4/assets/userTests/settings_change.png differ diff --git a/docs/documentation/demo_4/non_functional_tests.md b/docs/documentation/demo_4/non_functional_tests.md index f1720e6..5277a42 100644 --- a/docs/documentation/demo_4/non_functional_tests.md +++ b/docs/documentation/demo_4/non_functional_tests.md @@ -12,6 +12,7 @@ * [Introduction](#introduction) * [Performance Test](#performance-testing) * [Reliability Test](#reliability-test) +* [User Test](#user-test) ## Introduction The following document outlines some of the non functional testing we performed to ensure the quality requirements as outlined in our documentation. @@ -75,4 +76,39 @@ make python_non_functional Having run this test we can see from the output that no file's integrity has been compromised by any of the operations as the file's SHA256 hash remained unchanged. -![Reliability Test](assets/testingAssets/reliability.png) \ No newline at end of file +![Reliability Test](assets/testingAssets/reliability.png) + +# User tests + +### Introduction +Users were given an installed version of the app and were asked to perform some tasks like changing some settings and performing an advanced search etc. After this users were then given a fully anonymous google form to fill out on their experience with the application + +#### Ease of use +the general user consensus was very positive around ease of use. 86% of respondents scored the ease of use 5/5 with only 14% selecting 4/5 + +![Ease of use](assets/userTests/ease_of_use.png) + +This displays the the overall UI is one that is user friendly and provides great user experiences + +#### Loading times +Our app relies on an in memory version of your file system, meaning that loading the file system structure into the app can sometimes take long. this being said the responses around loading times were as expected. mostly positive but some users described the loading times as only "manageable" + +![Load times](assets/userTests/Load_times.png) + + +#### Settings change +Users were tasked with changing how the application changes folder names after sorting. for this task 29% of users selected 4/5 for ease of use. While the rest of the users chose 5/5. an almost 30% having some trouble for a task this simple(one button in the setting page) should be looked into for future ui changes. +![settings task](assets/userTests/settings_change.png) + +#### Key word search +This task was performed easily by all members, as displayed by the graph below. No improvements were necessary here. +![kw search](assets/userTests/search.png) + +# Folder view preference +This is just out of interest, we wanted to see wether users preferred the new and improved way of viewing all their files and folders. The respondents preferred the Graph view with a 71% majority. +![folder view](assets/userTests/preference.png) + +# Open ended feedback +The following were the responses from the optional open ended question. 2 users suggested the feature of being able to create files/folders in the app while one user wanted faster loading times. + +![open ended](assets/userTests/open_ended.png) \ No newline at end of file diff --git a/golang/README.md b/golang/README.md index 6842021..8514713 100644 --- a/golang/README.md +++ b/golang/README.md @@ -1,8 +1,6 @@ go get -u github.com/golang/protobuf/ go get -u google.golang.org/grpc -go get github.com/blevesearch/bleve/v2 - go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest go install google.golang.org/protobuf/cmd/protoc-gen-go@latest \ No newline at end of file