sync

.gitignore

@@ -1,9 +1,8 @@
 .vscode
-*.pdf
 node_modules
 *.py
 frontend/package-lock.json
 frontend/package.json
 frontend/eslint.config.mjs
 backend/lrg_backend/target
-backend/lrg_backend/data
+backend/lrg_backend/data

README.md

@@ -2,12 +2,20 @@
 
 ## About
 
-School project for WMC. Guide to ricing linux systems
+A school project for WMC 2024/25 at the [HTL Leonding](https://www.htl-leonding.at/)
+
+A Site to guide and teach how to ricing linux systems
+
+---
+
+## Project Description
 
 [Project Description](./about/project-description.md)
 
-![Use Case Diagram](./about/use-case-diagram.svg)
+---
+
+## Use case
 
-## Hosting
+![Use Case Diagram](./about/use-case.svg)
 
-Currently no hosting
+---

about/project-description.md

@@ -1,74 +1,75 @@
 # Linux ricing guide
 
-**Team members**
-Mostbauer, Reitbauer, Hassani, Dirnberger
+## Team Members
 
-**Project Name:**  
-Linux ricing
+Mostbauer, Reitbauer, Hassani, Dirnberger
 
 ---
 
-## Initial Situation
+## Project Name
 
-Ricing(customizing) linux can be difficult for beginners.
-A guid to explain what a ricing is and how to do it, can
-help introduce people to the topic, and help them get the
-result they want
+Linux Ricing Guide
 
 ---
 
-## Goals | Non-Goals
-
-**Project Goals:**
-Showcasing how to customize the terminal, the window manager, etc.
+## Initial Situation
 
-**Non-Goals:**
-Showcasing base linux usage. Knowledge of linux is required.
-A detailed guide for each of the many listed technologies.
+Customizing (or “ricing”) a Linux environment can be overwhelming, especially for beginners. With so many options for window managers, terminals, shells, and themes, it’s difficult to know where to start. This project addresses that gap by providing a clear, interactive guide to help users understand what ricing is and how to build a setup tailored to their needs.
 
 ---
 
-## Project Contents
-
-Tutorial on how to customize certain aspects of your linux environment.
-
----
+## Goals | Non-Goals
 
-## Critical Success Factors
+### Project Goals (All completed)
 
-List of factors that are critical to the project's success.
+- Provide an undestandable guide to customize key components of a Linux system:
+  - Terminal
+  - Window Manager (WM)
+  - Desktop Environment (DE)
+  - Shell
+  - Package Manager
+  - Themes and utilities
 
--   Listing technologies for customization
+- Easy navigation experience
+- Enable users to log into an account for the site.
+- Allow commenting and rating** on individual technologies and setups.
+- Show homepage for each tool.
+- Feature example setups from the team.
+- Include documentation about ricing, Linux concepts, history, and installation guides.
+- Provide an overview of the tools and technologies used in the project.
+- Style the entire site for both desktop and mobile users.
 
-    -   Adding links to the repo and/or home page of each program.
+### Non-Goals
 
--   Styling the site for desktop and mobile devices.
+- Teaching basic Linux usage.
+  - Terminal, root/sudo, hardware/drivers (webcames, etc)
+- Providing very deep and hyper specific tutorials for every listed technology.
 
 ---
 
-## Milestones
+## Project Contents
 
-**Project Start:**
+- Interactive Linux ricing configurator.
+- Good feeling and simple navigation (tree, graph, search).
+- Community features: discussions, comments, ratings.
+- Informational pages on Linux customization and background.
+- Personal setups with screenshots.
+- Authentication via Google and GitHub (auth0).
+- UI designed for both desktop and mobile.
 
--   Event: Initial meeting in class during wmc lesson
--   Date: 18.10.2024
+---
 
-**Pre Coding**
+## Critical Success Factors
 
--   [x] Find Idea
--   [x] Create Project Skeleton
--   [x] Create Repo
--   [x] Invite Members
--   [x] Assign tasks
+- Clear structure to find what you need easily.
+- Smooth user experience on both desktop and mobile.
+- Active user interaction features (comments, ratings).
+- Visually appealing and accessible presentation.
 
-**Milestones:**
+---
 
--   [ ] Ricing introduction complete: 1. Dez.
--   [ ] Personal-Setups complete: 10. Dez.
--   [ ] Main page complete: 11. Dez.
--   [ ] Styling complete: 12. Dez.
+## Project Status
 
-**Project End:**
+All goals and features listed above have been completed.
 
--   Event: Showcase of final site
--   Date: 12. Dez.
+---

about/use-case.puml

@@ -1,42 +1,86 @@
 @startuml
 actor User
 
-rectangle "Linux ricing guide" {
-
-  package "Utilities" {
-    usecase "Configurator Tool" as UC11
-    usecase "Search Utility" as UC12
-
-    package "Custom Downloader" {
-      usecase "Choose Linux Distributions" as UC1
-      usecase "Select Window Managers" as UC2
-      usecase "Explore Desktop Environments" as UC3
-      usecase "Pick Terminals and Themes" as UC4
-      usecase "Select Shells" as UC5
-      usecase "Add Package Managers" as UC6
-      usecase "Download Custom Setup" as UC7
-    }
+rectangle "Linux Ricing Guide Website" {
+
+  package "User Accounts" {
+    usecase "Log in with Google" as UC_LoginGoogle
+    usecase "Log in with GitHub" as UC_LoginGitHub
+  }
+
+  package "Community & Feedback" {
+    usecase "Participate in Discussions" as UC_Discuss
+    usecase "Leave Comments" as UC_Comment
+    usecase "Rate Comments" as UC_RateComments
+    usecase "Rate Distros" as UC_RateDistros
+  }
+
+  package "System Setup Configurator" {
+    usecase "Select Linux Distribution" as UC_SelectDistro
+    usecase "Select Window Manager" as UC_SelectWM
+    usecase "Select Desktop Environment" as UC_SelectDE
+    usecase "Choose Terminals and Themes" as UC_SelectTerm
+    usecase "Choose Shell" as UC_SelectShell
+    usecase "Add Package Manager" as UC_AddPkgMgr
+    usecase "Visit Project Homepages" as UC_Homepages
+  }
+
+  package "Documentation & Guides" {
+    usecase "Linux Concepts Overview" as UC_LinuxOverview
+    usecase "Installation Guides" as UC_InstallGuides
+    usecase "Distro & Linux History" as UC_History
   }
 
+  package "About the Project" {
+    usecase "View Our Setups" as UC_OurSetups
+    usecase "Technologies Used" as UC_TechUsed
+    usecase "About Us" as UC_AboutUs
+    usecase "About This Page" as UC_AboutPage
+    usecase "Contributions Page" as UC_Contributions
+  }
 
-  package "History and Information" {
-    usecase "Explore Linux Distributions" as UC8
-    usecase "View Distro Histories" as UC9
-    usecase "View example Setups" as UC10
+
+  package "Navigation Methods" {
+    usecase "Browse via File Tree" as UC_TreeNav
+    usecase "Browse via Node Graph" as UC_NodeNav
+    usecase "Search with Highlighting" as UC_Search
   }
 
-  UC8 --> UC9
-  UC11 --> UC7
-  UC1 --> UC11
-  UC2 --> UC11
-  UC3 --> UC11
-  UC4 --> UC11
-  UC5 --> UC11
-  UC6 --> UC11
-
-  User --> UC11
-  User --> UC12
-  User --> UC8
-  User --> UC10
+  UC_Discuss --> UC_Comment
+  UC_Discuss --> UC_RateComments
+
+  UC_SelectDistro --> UC_Homepages
+  UC_SelectWM --> UC_Homepages
+  UC_SelectDE --> UC_Homepages
+  UC_SelectTerm --> UC_Homepages
+  UC_SelectShell --> UC_Homepages
+  UC_AddPkgMgr --> UC_Homepages
+
+  User --> UC_LoginGoogle
+  User --> UC_LoginGitHub
+
+  User --> UC_Discuss
+  User --> UC_RateDistros
+
+  User --> UC_SelectDistro
+  User --> UC_SelectWM
+  User --> UC_SelectDE
+  User --> UC_SelectTerm
+  User --> UC_SelectShell
+  User --> UC_AddPkgMgr
+
+  User --> UC_LinuxOverview
+  User --> UC_InstallGuides
+  User --> UC_History
+
+  User --> UC_OurSetups
+  User --> UC_TechUsed
+  User --> UC_AboutUs
+  User --> UC_AboutPage
+  User --> UC_Contributions
+
+  User --> UC_TreeNav
+  User --> UC_NodeNav
+  User --> UC_Search
 }
-@enduml
+@enduml