Merging some stuff

Merge branch 'main' of ssh://github.com/CSSE6400/P01-UniBasement

.github/workflows/main.yml

@@ -0,0 +1,34 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    # Install Node.js and cache dependencies
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+
+    # Run frontend build and test
+    - name: Build and test
+      run: |
+        npm ci
+        npm run build --if-present
+        npm test
+      working-directory: frontend

README.md

@@ -1,5 +1,5 @@
 # UniBasement
-### [Architecture](ARCHITECTURE.md) | [Handshake](HANDSHAKE.md) | [AI](AI.md)
+### [Architecture](docs/ARCHITECTURE.md) | [Handshake](docs/HANDSHAKE.md) | [Database](docs/DATABASE.md) | [AI](docs/AI.md)
 
 ## Description
 UniBasement is designed to empower students to understand the concepts in a deeper manner, at the forefront of the platform is the desire to enable students to have a deeper understanding of the content they are taught and to work with their peers to develop their collective understanding. Within the modern world, studying is more than ever stressful and makes student anxious, easy access to materials to enable students to study in a more effective manner is essential and UniBasement intends to make studying for final exams an easier affair.  

backend/.dockerignore

@@ -1,2 +1 @@
 node_modules
-package-lock.json

backend/Dockerfile

@@ -2,8 +2,12 @@ FROM node:latest
 
 WORKDIR /app
 
-COPY . /app
+COPY ./package.json /app
+COPY ./package-lock.json /app
+RUN npm ci
 
-RUN npm install
+COPY ./index.ts .
+COPY ./db ./db
+COPY ./routes ./routes
 
 CMD ["npm", "run", "start"]

backend/db/index.ts

@@ -1,8 +1,6 @@
 // Imports
 import { Pool } from 'pg'
 
-const dotenv = require('dotenv');
-
 const pool = new Pool({
     user: process.env.DB_USER,
     host: process.env.DB_HOST,

backend/docker-compose.yml

@@ -20,9 +20,9 @@ services:
   db:
     image: postgres:latest
     environment:
-      DB_USER: "postgres" 
-      DB_PASSWORD: "postgres"
-      DB_DATABASE: "postgres"
+      POSTGRES_USER: "postgres"
+      POSTGRES_PASSWORD: "postgres"
+      POSTGRES_DATABASE: "postgres"
 
   adminer:
     image: adminer

backend/index.ts

@@ -8,10 +8,6 @@ import cors from 'cors';
 import { routes } from './routes/index';
 import * as db from './db/index';
 
-const dotenv = require('dotenv');
-
-dotenv.config();
-
 const PORT: number = process.env.PORT ? parseInt(process.env.PORT) : 8080;
 
 // Make the app

backend/package.json

@@ -15,7 +15,6 @@
     "@types/pg": "^8.11.5",
     "@types/uuid": "^9.0.8",
     "cors": "^2.8.5",
-    "dotenv": "^16.4.5",
     "express": "^4.19.2",
     "pg": "^8.11.5",
     "uuid": "^9.0.1"

backend/routes/routes.ts

@@ -41,6 +41,7 @@ export const router = Router();
  * See outputs and params in HANDSHAKE.md
  *
  */ 
+
 // Comments by question id
 router.get('/questions/:questionId', async (req: Request, res: Response) => {
     const questionID = req.params.questionId;
@@ -113,8 +114,9 @@ router.get('/evan', async (req: Request, res: Response) => {
     res.status(200).json('Evan is the best');
 });
 
-// Helper functions
+// Interfaces
 
+// Used in nest helper function
 interface CommentObject {
     commentsid: number;
     parentcommentid: number | null;
@@ -129,7 +131,9 @@ interface CommentObject {
     children?: CommentObject[];
 }
 
-// Recursive function to nest comments into their parent comments
+// Helper functions
+
+// Function to nest comments into their parent comments
 function nest(jsonData: any[]) {
     const dataDict: { [id: number]: CommentObject } = {};
     jsonData.forEach(item => dataDict[item.commentsid] = item);

docs/DATABASE.md

@@ -0,0 +1,26 @@
+# TODO
+
+# Courses
+| Name | Type | Description | other |
+|----|----|----|----|
+| courseCode | VARCHAR(8) | The Course Code for a course i.e. CSSE6400 | key |
+| courseName | meow | The name of the course i.e. Software Architecture | None |
+| courseDescription | meow | A description for the course | None |
+
+# Exams
+| Name | Type | Description | other |
+|----|----|----|----|
+| coursecode | VARCHAR(8) | The Course Code for a course i.e. CSSE6400 | reference to courses table |
+| examId | Serial | Just the id for the database | key |
+
+# Questions
+| Name | Type | Description | other |
+|----|----|----|----|
+| examId | Serial | Just the id for the exams database | reference to the exams table |
+| questionId | Serial | Just the id for the database | key |
+
+# Comments
+| Name | Type | Description | other |
+|----|----|----|----|
+| questionId | Serial | Just the id for the questions database | reference to the questions table |
+| commentsId | Serial | Just the id for the database | key |

HANDSHAKE.md → docs/HANDSHAKE.md

@@ -56,7 +56,7 @@ None
   }
 ]
 ```
-# /exams/:examid/:questionid GET
+# /questions/:questionid GET NEEDS UPDATING
 ### Path params:
 | Name | Description |
 |----|----|

frontend/next.config.mjs

@@ -16,7 +16,6 @@ const withMDX = nextMDX({
 /** @type {import('next').NextConfig} */
 const nextConfig = {
   pageExtensions: ['js', 'jsx', 'ts', 'tsx', 'mdx'],
-  output: 'export',
   basePath: '/UniBasement',
   images: {
     unoptimized: true,