Activities Backend

.github/workflows/ci.yml

@@ -0,0 +1,96 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js 18
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: 'npm'
+
+      # middlewareNode
+      - name: Install dependencies (middlewareNode)
+        run: npm ci
+        working-directory: ./middlewareNode
+
+      - name: Build middlewareNode
+        run: npm run build --if-present
+        working-directory: ./middlewareNode
+
+      # chessClient
+      - name: Install dependencies (chessClient)
+        run: npm ci
+        working-directory: ./chessClient
+
+      - name: Lint chessClient
+        run: npm run lint
+        working-directory: ./chessClient
+
+      # chessServer
+      - name: Install dependencies (chessServer)
+        run: npm ci
+        working-directory: ./chessServer
+
+      - name: Build chessServer
+        run: npm run build --if-present
+        working-directory: ./chessServer
+
+      - name: Test chessServer
+        run: npm test
+        working-directory: ./chessServer
+
+      # stockfishServer
+      - name: Install dependencies (stockfishServer)
+        run: npm ci
+        working-directory: ./stockfishServer
+
+      - name: Build stockfishServer
+        run: npm run build --if-present
+        working-directory: ./stockfishServer
+
+      - name: Test stockfishServer
+        run: npm test
+        working-directory: ./stockfishServer
+
+      # react frontend
+      - name: Install dependencies (react frontend)
+        run: npm ci
+        working-directory: ./react-ystemandchess
+
+      - name: Create environment file
+        run: |
+          mkdir -p src/environments
+          cat <<EOF > src/environments/environment.js
+          export const environment = {
+            production: false,
+            agora: {
+              appId: '${{ secrets.APP_ID }}',
+            },
+            urls: {
+              middlewareURL: '${{ secrets.MIDDLEWARE_URL }}',
+              chessClientURL: '${{ secrets.CHESS_CLIENT_URL }}',
+              stockFishURL: '${{ secrets.STOCKFISH_URL }}',
+              chessServer: '${{ secrets.CHESS_SERVER }}',
+            },
+          };
+          EOF
+        working-directory: ./react-ystemandchess
+
+      - name: Build react-ystemandchess
+        run: CI=false npm run build --if-present
+        working-directory: ./react-ystemandchess
+
+      - name: Test react-ystemandchess
+        run: npm test
+        working-directory: ./react-ystemandchess

README.md

@@ -6,32 +6,60 @@ This is an educational platform that combines chess instruction with STEM learni
 
 ## Development Environment Setup
 
-To run the platform, you’ll need **Node.js v14**, **nodemon**, and **Apache** installed.
+To run the platform, you’ll need **Node.js v18**, **nodemon**, and **Apache** installed.
 
 ### NodeJS
 
-This project requires NodeJS version 14.
+This project requires **Node.js v18.20.8**.
 
-**Linux:**
-
-```bash
-curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash -
-sudo apt-get install -y nodejs
-```
-
-**macOS:**
-
-```bash
-brew install node@14
-```
-
-Or download from [nodejs.org](https://nodejs.org/)
-
-**Windows:**
-Download and install from [nodejs.org](https://nodejs.org/)
+We recommend using a version manager so everyone runs the same Node.js version consistently.
 
 ---
 
+### Option 1: Using [Volta](https://volta.sh) (recommended)
+
+Volta automatically uses the Node version pinned in this project’s `package.json`.
+
+**Install Volta:**
+
+- **Linux / macOS:**
+    ```bash
+    curl https://get.volta.sh | bash
+    source ~/.bashrc # or ~/.zshrc
+    ```
+- **Windows:**
+Download and run the installer from [volta.sh](https://volta.sh)
+
+Now when you cd into this project, Volta will automatically install and use **Node.js v18.20.8**.
+
+### Option 2: Using [nvm](https://github.com/nvm-sh/nvm)
+
+If you prefer nvm:
+
+- **Linux / macOS:**
+    ```bash
+    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
+    source ~/.nvm/nvm.sh
+    ```
+    Then:
+    ```bash
+    nvm install 18.20.8
+    nvm use 18.20.8
+    ```
+    (Optional) Set it as default:
+    ```bash
+    nvm alias default 18.20.8
+    ```
+- **Windows:**
+    Use [nvm-windows](https://github.com/coreybutler/nvm-windows):
+
+    Download and run the installer from the [releases page](https://github.com/coreybutler/nvm-windows/releases).
+    Then install and use Node:
+    ```powershell
+    nvm install 18.20.8
+    nvm use 18.20.8
+    ```
+
 ### Nodemon
 
 Nodemon automatically restarts your server whenever code changes are detected.
@@ -109,6 +137,12 @@ npm start      # Start the API server
 
 The server typically runs on port 8000. You should see "MongoDB Connected..." when it starts successfully.
 
+**If you intend to test the mentor and student login pages, you may use the following usernames and passwords respectively:**
+
+mentor 123123123
+
+student 123123123
+
 ---
 
 #### Main React Application (Frontend)
@@ -155,14 +189,13 @@ This service usually runs on port 8080.
 
 #### Chess Client (Testing Interface)
 
-Provides different views of the chess board for development:
-
 ```bash
 cd chessClient
 npm install
 ```
 
-You can use the **Live Server extension in VS Code** to open the HTML files:
+Run the http server on port 80 using: `npx http-server -p 80` to ensure that the chess board frame loads during any session.
+You can use the **Live Server extension in VS Code** to open the HTML files for local testing of the chess board:
 
 * **Board only:** Right-click `index.html` → "Open with Live Server"
 * **Board with controls:** Right-click `parent.html` → "Open with Live Server"