Merge branch 'main' of github.com:jkluge/Find-My-Next-Course into persistance

Author: jkluge

README.md

@@ -0,0 +1,27 @@
+Project Structure Draft:
+
+```
+.
+├── firebase.js      // handles fetching and saving to the realtime database on firebase
+├── firebase.json    // used for firebase deploy
+├── index.html       // the main index page - contains header and loads the index.jsx
+├── package.json     // used for nodejs (npm) packages
+├── package-lock.json    // used for nodejs (npm) packages
+├── README.md        // this file ^^
+├── src              // contains all source filed
+│   ├── assets       //  content, e.g. pictures, ressources etc.
+│   │   └── react.svg
+│   ├── index.jsx    // the react router - routes between pages, all pages are inserted here
+│   ├── model.js     // the model - handles prog. logic, that is either global or account specific
+│   ├── pages        // pages combine the presenters to a webpage. mby obsolete for 1 page project
+│   │   └── App.jsx  // The future homepage?
+│   ├── presenters   // Presenters link views and the model. 
+│   |                   Hooks to modify the model & component  state is defined here
+│   │   └── HandleSearchPresenter.jsx  // An example presenter
+│   ├── styles.css   // a style document - mby one for each view?
+│   └── views        // views define parts of pages cosmetically. 
+│       └── DummyView.jsx
+└── vite.config.js
+```
+
+

my-app/package-lock.json

@@ -10,10 +10,10 @@
     "preview": "vite preview"
   },
   "dependencies": {
-
+    "@dagrejs/dagre": "^1.1.4",
     "@headlessui/react": "^2.2.1",
     "@heroicons/react": "^2.2.0",
-    "@dagrejs/dagre": "^1.1.4",
+    "@react-buddy/ide-toolbox": "^2.4.0",
     "@tailwindcss/vite": "^4.0.17",
     "@xyflow/react": "^12.5.5",
     "autoprefixer": "^10.4.21",

my-app/package.json

@@ -145248,4 +145248,4 @@
         "prerequisites_text": "null",
         "learning_outcomes": "null"
     }
-}
+}

my-app/src/assets/example.json

@@ -0,0 +1,70 @@
+This directory contains utility files which enable some visual features of the
+[React Buddy](https://plugins.jetbrains.com/plugin/17467-react-buddy/) plugin.
+Files in the directory should be committed to source control.
+
+React Buddy palettes describe reusable components and building blocks. `React Palette` tool window becomes available
+when an editor with React components is active. You can drag and drop items from the tool window to the code editor or
+JSX Outline. Alternatively, you can insert components from the palette using code generation action (`alt+insert` /
+`⌘ N`).
+
+Add components to the palette using `Add to React Palette` intention or via palette editor (look for the corresponding
+link in `palette.tsx`). There are some ready-to-use palettes for popular React libraries which are published as npm
+packages and can be added as a dependency:
+
+```jsx
+import AntdPalette from "@react-buddy/palette-antd";
+import ReactIntlPalette from "@react-buddy/palette-react-intl";
+
+export const PaletteTree = () => (
+  <Palette>
+    <AntdPalette/> 
+    <ReactIntlPalette/>
+    <Category name="App templates">
+      <Component name="Card">
+        <Variant name="Loading">
+          <Card title="Card title">
+            <Skeleton loading={true} avatar active>
+                Card content
+            </Skeleton>
+          </Card>
+        </Variant>
+      </Component>
+      <Component name="Form">
+        <Variant proto={FormTemplate}/>
+      </Component>
+    </Category>
+  </Palette>
+)
+```
+
+React Buddy explicitly registers any previewed component in the `previews.tsx` file so that you can specify required
+props.
+
+```jsx
+<ComponentPreview path="/Page">
+    <Page title={'Hello'}/>
+</ComponentPreview>
+```
+
+You can add some global initialization logic for the preview mode in `useInitital.ts`,
+e.g. implicitly obtain user session:
+
+```typescript
+export const useInitial: () => InitialHookStatus = () => {
+    const [loading, setLoading] = useState<boolean>(false);
+    const [error, setError] = useState<boolean>(false);
+
+    useEffect(() => {
+        setLoading(true);
+        async function login() {
+            const response = await loginRequest(DEV_LOGIN, DEV_PASSWORD);
+            if (response?.status !== 200) {
+                setError(true);
+            }
+            setLoading(false);
+        }
+        login();
+    }, []);
+    return { loading, error };
+};
+```

my-app/src/dev/README.md

@@ -0,0 +1,9 @@
+import React from "react"
+import {useInitial} from "./useInitial"
+
+const ComponentPreviews = React.lazy(() => import("./previews"))
+
+export {
+    ComponentPreviews,
+    useInitial
+}

my-app/src/dev/index.js

@@ -0,0 +1,25 @@
+import {Fragment} from "react"
+import {
+    Category,
+    Component,
+    Variant,
+    Palette,
+} from "@react-buddy/ide-toolbox"
+
+export const PaletteTree = () => (
+    <Palette>
+        <Category name="App">
+            <Component name="Loader">
+                <Variant>
+                    <ExampleLoaderComponent/>
+                </Variant>
+            </Component>
+        </Category>
+    </Palette>
+)
+
+export function ExampleLoaderComponent() {
+    return (
+        <Fragment>Loading...</Fragment>
+    )
+}

my-app/src/dev/palette.jsx

@@ -0,0 +1,11 @@
+import {Previews} from '@react-buddy/ide-toolbox'
+import {PaletteTree} from './palette'
+
+const ComponentPreviews = () => {
+    return (
+        <Previews palette={<PaletteTree/>}>
+        </Previews>
+    )
+}
+
+export default ComponentPreviews

my-app/src/dev/previews.jsx

@@ -0,0 +1,15 @@
+import {useState} from 'react'
+
+export const useInitial = () => {
+    const [status, setStatus] = useState({
+        loading: false,
+        error: false
+    })
+    /*
+      Implement hook functionality here.
+      If you need to execute async operation, set loading to true and when it's over, set loading to false.
+      If you caught some errors, set error status to true.
+      Initial hook is considered to be successfully completed if it will return {loading: false, error: false}.
+    */
+    return status
+}

my-app/src/dev/useInitial.js

@@ -18,16 +18,20 @@ export const model = {
         applyTranscriptFilter: true,
         eligibility: "weak",  //the possible values for the string are: "weak"/"moderate"/"strong"
         applyLevelFilter: true,
-        level: [], //the possible values for the array are: "PREPARATORY", "BASIC", "ADVANCED", "RESEARCH"
+        level: ["PREPARATORY", "BASIC", "ADVANCED", "RESEARCH"], //the possible values for the array are: "PREPARATORY", "BASIC", "ADVANCED", "RESEARCH"
         applyLanguageFilter: true,
         language: "none", //the possible values for the string are: "none"/"english"/"swedish"/"both"
         applyLocationFilter:true,
         location: [], //the possible values for the array are: 'KTH Campus', 'KTH Kista', 'AlbaNova', 'KTH Flemingsberg', 'KTH Solna', 'KTH Södertälje', 'Handelshögskolan', 'KI Solna', 'Stockholms universitet', 'KONSTFACK'
         applyCreditsFilter:true,
         creditMin: 0,
         creditMax: 45,
-        applyDepartmentFilter:false,
-        department: []
+        applyDepartmentFilter: true,
+        department: ["EECS/Computational Science and  Technology", "EECS/Theoretical Computer Science", "EECS/Electric Power and Energy Systems", "EECS/Network and Systems Engineering",
+        "ITM/Learning in Engineering Sciences", "ITM/Industrial Economics and Management", "ITM/Energy Systems", "ITM/Integrated Product Development and Design", "ITM/SKD GRU",
+        "SCI/Mathematics", "SCI/Applied Physics", "SCI/Mechanics", "SCI/Aeronautical and Vehicle Engineering", 
+        "ABE/Sustainability and Environmental Engineering", "ABE/Concrete Structures", "ABE/Structural Design & Bridges", "ABE/History of Science, Technology and Environment", ],
+        applyRemoveNullCourses: false
     },
 
     setUser(user) {
@@ -84,15 +88,17 @@ export const model = {
         entries.forEach(entry => {
             const course = {
                 code: entry[1].code,
-                name: entry[1]?.name ?? "",
-                location: entry[1]?.location ?? "",
-                department: entry[1]?.department ?? "",
-                language: entry[1]?.language ?? "",
-                description: entry[1]?.description ?? "",
-                academicLevel: entry[1]?.academic_level ?? "",
-                period: entry[1]?.period ?? "",
+                name: entry[1]?.name ?? "null",
+                location: entry[1]?.location ?? "null",
+                department: entry[1]?.department ?? "null",
+                language: entry[1]?.language ?? "null",
+                description: entry[1]?.description ?? "null",
+                academicLevel: entry[1]?.academic_level ?? "null",
+                period: entry[1]?.period ?? "null",
                 credits: entry[1]?.credits ?? 0,
-                prerequisites: entry[1]?.prerequisites ?? "",
+                prerequisites: entry[1]?.prerequisites ?? "null",
+                prerequisites_text: entry[1]?.prerequisites_text ?? "null",
+                learning_outcomes: entry[1]?.learning_outcomes ?? "null"
             };
             this.addCourse(course);
         });
@@ -129,6 +135,11 @@ export const model = {
         this.filterOptions = options; // do we want to set the flags? What about useEffect?
     },
 
+    setApplyRemoveNullCourses() {
+        this.filterOptions.applyRemoveNullCourses = !this.filterOptions.applyRemoveNullCourses;
+        this.setFiltersChange();
+    },
+
     updateLevelFilter(level) {
         this.filterOptions.level = level;
     },
@@ -146,6 +157,10 @@ export const model = {
         this.filterOptions.eligibility = eligibility;
     },
 
+    updateDepartmentFilter(department) {
+        this.filterOptions.department = department;
+    },
+
     //setters for the filter options
     setApplyTranscriptFilter(transcriptFilterState) {
         this.filterOptions.applyTranscriptFilter = transcriptFilterState;
@@ -162,10 +177,16 @@ export const model = {
     setApplyCreditsFilter(creditsFilterState) {
         this.filterOptions.applyCreditsFilter = creditsFilterState;
     },
-    // setApplyDepartmentFilter(departmentFilterState) {
-    //     this.filterOptions.applyDepartmentFilter = departmentFilterState;
-    // },
+    setApplyDepartmentFilter(departmentFilterState) {
+        this.filterOptions.applyDepartmentFilter = departmentFilterState;
+    },
 
+    async getAverageRating(courseCode) {
+        const reviews = await getReviewsForCourse(courseCode);
+        if (!reviews || reviews.length === 0) return null;
+        const total = reviews.reduce((sum, review) => sum + (review.overallRating || 0), 0);
+        return (total / reviews.length).toFixed(1);
+    },
 
 
 };