Setup ci pipeline

.docker/config/config.json

@@ -0,0 +1,18 @@
+{
+    "url": "http://17313-team09.s3d.cmu.edu:4567",
+    "secret": "d1d17b11-96bb-4f8f-96f7-04ecd1175001",
+    "database": "redis",
+    "port": "4567",
+    "redis": {
+        "host": "redis",
+        "port": 6379,
+        "password": "",
+        "database": 0
+    },
+    "test_database": {
+        "host": "redis",
+        "port": "6379",
+        "password": "",
+        "database": "1"
+    }
+}

.github/workflows/VM Deploy.yml

@@ -0,0 +1,36 @@
+name: VM Deploy NodeBB
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  build-and-deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node.js version
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20.17.0'
+
+      - name: Deploy via SSH
+        uses: appleboy/ssh-action@v1.2.1
+        with:
+          host: ${{ secrets.SERVER_IP }}
+          username: ${{ secrets.SERVER_ADMIN }}
+          password: ${{ secrets.ADMIN_PASSWORD }}
+          script: | 
+            cd ${{ secrets.REPO_NAME }}
+            git pull origin main
+            docker compose down
+            docker compose -f docker-compose-redis.yml up --build -d

.github/workflows/snyk-security.yml

@@ -0,0 +1,47 @@
+name: Snyk Security Scan
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  security-analysis:
+    runs-on: ubuntu-latest
+    env:
+      SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20' # Standard NodeBB LTS version
+
+      - name: Install dependencies
+        run: npm ci
+
+      # We only fail the build for HIGH severity issues to avoid blocking development for low-risk testing files
+      - name: Run Snyk Code (SAST)
+        if: ${{ env.SNYK_TOKEN != '' }}
+        run: |
+          set +e
+          npx snyk code test --severity-threshold=high
+          snyk_exit_code=$?
+
+          # Exit code 1 means vulnerabilities were found. Keep the workflow green,
+          # but surface the findings in job logs for visibility.
+          if [ "$snyk_exit_code" -eq 1 ]; then
+            echo "Snyk found vulnerabilities (non-blocking for this course project)."
+            exit 0
+          fi
+
+          # Exit code 0 means no issues; any other code means scan/tool failure.
+          if [ "$snyk_exit_code" -ne 0 ]; then
+            echo "Snyk scan failed to run correctly (exit code: $snyk_exit_code)."
+            exit "$snyk_exit_code"
+          fi
+      - name: Skip scan when SNYK_TOKEN is missing
+        if: ${{ env.SNYK_TOKEN == '' }}
+        run: echo "SNYK_TOKEN is not set, skipping Snyk Code scan."

UserGuide.md

@@ -0,0 +1,38 @@
+# NodeBB Custom Features User Guide
+
+This guide outlines the custom features implemented to enhance the learning and communication experience for both students and instructional staff (Admins/TAs).
+
+## 1. Anonymous Posting
+Students can choose to mask their identity when asking questions or replying to topics to reduce the anxiety of participating in discussions.
+
+* **How to use it:** When creating a post or replying, use the new dropdown menu and select **"Post as: Post anonymously"** instead of "Show my name".
+* **Visibility Rules:**
+  * **Students:** See the post with a `?` profile picture and the username `Anonymous`.
+  * **Post Authors:** Always see their own real identity and avatar on their own anonymous posts.
+  * **Admins & TAs:** Always see the real identity and avatar of the student who posted, ensuring accountability.
+
+## 2. TA Question Resolution
+Instructional staff can mark questions as resolved to help triage student needs and keep the "Comments & Feedback" section organized.
+
+* **How it works:** * Unresolved questions automatically float to the top of the topic list for Admins/TAs.
+  * When a staff member reviews a question, they can click the gray **"Unresolved"** button to toggle it to a green **"Resolved"** state.
+  * Resolved questions move to the bottom of the view for staff, keeping the queue clean.
+* **Visibility:** Students can see the Resolved/Unresolved status of a post but cannot click or toggle the button themselves.
+
+## 3. Instructor Endorsements ("Supported by Instructor")
+Staff can officially endorse a student's answer or a particularly good post, signaling to the rest of the class that the information is accurate.
+
+* **How to use it (Staff Only):** * Click the 3-dot dropdown menu on any post.
+  * Select **"Support Answer"**.
+  * A green **"Supported by Instructor"** badge will immediately appear on the post.
+  * To remove the endorsement, open the dropdown again and select **"Remove Support"**.
+* **Visibility:** All users (students and staff) can see the green endorsement badge. 
+
+## 4. Announcement View Tracking
+Instructors can verify which students have read important class announcements. 
+
+* **How it works:** * When a student opens a post in the "Announcements" category, their view is automatically logged with a timestamp. 
+  * Staff views (Admins/TAs) are explicitly excluded from the tracking data.
+* **How to view the data (Staff Only):** * Navigate to any main post in the Announcements category.
+  * Click the eye icon (👁️) next to the reply button.
+  * A dropdown will display a list of all students who have viewed the post, including their avatars, display names, and the exact time they viewed it.

docker-compose-redis.yml

@@ -2,6 +2,7 @@ version: '3.8'
 
 services:
   nodebb:
+    user: "0"
     build: .
     # image: ghcr.io/nodebb/nodebb:latest
     restart: unless-stopped