Merge develop into feature with updated package.json settings

.github/workflows/ci.yml

@@ -13,18 +13,21 @@ jobs:
     env:
       working-directory: ./client-course-schedulizer
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
         with:
-          node-version: '14'
-      - name: update-npm-version
+          version: 8
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+      - name: update-pnpm-version
         run: |
-          npm install -g npm@latest
-      - name: Install npm dependencies
+          pnpm install -g pnpm@latest
+      - name: Install pnpm dependencies
         run: |
-          npm ci
+          pnpm install
         working-directory: ${{env.working-directory}}
       - name: Run tests
         run: |
-          npm test
+          pnpm test
         working-directory: ${{env.working-directory}}

.github/workflows/deploy.yml

@@ -11,18 +11,24 @@ jobs:
       working-directory: ./client-course-schedulizer
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [20.x]
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+      - name: update-pnpm-version
+        run: |
+          pnpm install -g pnpm@latest
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install Packages
-        run: npm install
+        run: pnpm install
         working-directory: ${{env.working-directory}}
       - name: Build Page
-        run: npm run build
+        run: pnpm build
         working-directory: ${{env.working-directory}}
       - name: Remove gh-pages Cache
         run: rm -rf node_modules/gh-pages/.cache

.vscode/course-schedulizer.code-workspace

@@ -8,15 +8,37 @@
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": true,
-      "source.organizeImports": true,
-      "source.fixAll": true
+      "source.fixAll.eslint": "explicit",
+      "source.organizeImports": "explicit",
+      "source.fixAll": "explicit"
     },
     "eslint.workingDirectories": [
       {
         "mode": "auto"
       }
-    ]
+    ],
+    "cSpell.dictionaries": ["en_US", "typescript", "node", "html", "css", "npm"],
+    "cSpell.enableFiletypes": ["html", "js", "json", "jsx", "markdown", "md", "scss", "ts", "tsx"],
+    "cSpell.words": [
+      "Corepack",
+      "CSPS",
+      "Faeren",
+      "Fitsum",
+      "Haileselassie",
+      "Kornoelje",
+      "Madza",
+      "Maru",
+      "Norvig",
+      "packagemanager",
+      "predeploy",
+      "Pruim",
+      "reuseables",
+      "Schedulizer",
+      "VanderLinden",
+      "Velpula",
+      "Vreeke"
+    ],
+    "cSpell.blockCheckingWhenTextChunkSizeGreaterThan": 1500 // Allow checking of files with long base64 strings.
   },
   "extensions": {
     "recommendations": [

DOCUMENTATION.md

@@ -0,0 +1,60 @@
+Course Schedulizer: DOCUMENTATION
+
+
+
+
+
+- How to run the `develop` branch locally for developers:
+  - `git clone`: clone the repo to local computer and `cd` into the folder
+  - `git checkout develop`: switch to `develop` branch
+  - `cd client-course-schedulizer`: `cd` into the client folder
+  - `pnpm install`: install all packages in package.json
+    - Current requirement: pnpm 8.6.0 or above, node 18 or above
+  - `pnpm start`: run the website on localhost:3000
+- Develop Branch - For development, deployed on [Course Schedulizer (sharp-babbage-a45ee2.netlify.app)](https://sharp-babbage-a45ee2.netlify.app/#/)
+- .github/workflows: the github auto-test and auto-deploy scripts
+  - ci.yml: automatically test the latest update
+    - Trigger: push to all branches, PR to `develop` and `production`
+    - Work environment: ./client-course-schedulizer
+    - Steps:
+      - Set up actions for pnpm and node
+      - Update pnpm version
+      - Install pnpm dependencies
+      - Run pnpm test on the latest push or PR
+  - deploy.yml: auto-deploy
+    - This script is not updated to use pnpm yet, must be updated before pushing to `production` or error will occur
+- Important files: client-course-schedulizer/csv
+  - This folder contains sample course schedules in .csv and .xlsx formats
+  - Not compatible with latest Workday format, might be replaced in later versions
+- Important files: client-course-schedulizer/src - 
+  - Folder `assets` - Contains images utilized by the application
+  - Folder `components` - Contains important elements of the program interface (to be discussed in further detail later)
+  - Folder `data` - Features constraints on times within which classes may start
+    - May need to run some outside R command to get the correct data
+    - Ask Prof. Pruim for more information about how this folder works
+  - Folder `styles` - Establishes colors and fonts used in the application
+  - Folder `types` - Establishes objects used in the application (best not to alter this)
+  - Folder `utilities` - Various functions and objects to help the application function (to be discussed in further detail later)
+  - Other files - Handle server operations
+- Important Files - src/components
+  - App Folder - Features navigational components, and tests to run
+    - App/App.tsx - Provides navigational info
+  - Footer Folder - Handles display of the bottom of the page
+  - Header Folder - Handles display of the top of the page, including navigational buttons
+  - Tabs Folder - Handles tabs that appear in the Schedulizer window
+  - Toolbar Folder - Handles functions in toolbars that appear in the Schedulizer window
+  - Pages Folder - Handles the pages that are accessible by way of the header
+    - SchedulizerPage - Implements the Tabs found in the components/Tabs folder
+    - AboutPage - Contains some information regarding the Schedulizer, and the developers working on it
+      - AboutPage/TeamMemberProfile - Handles team members as objects to display uniformly
+    - HelpPage - Displays information that will help new users learn to use the application
+    - HarmonyPage - Highly Experimental - A system meant to create an ideal schedule based on constraints, currently nonfunctional and not under active development		NOT IN USE NOW
+  - Reusables Folder - Handles object-classes that are used in various parts of the app
+- Important Files - src/utilities
+  - Contexts - Establish the global state of the app
+  - Helpers - Provide various helpful functions for development use
+  - Hooks - Provide hooks for interacting with the schedule
+  - Interfaces - Define the app interfaces and data interfaces
+  - Reducers - Provide a function to perform multiple setState updates at once that depend on each other.
+  - Services - Provide services for eg: detecting conflict, calculate faculty load, etc.
+