Merge pull request #37 from COS301-SE-2024/stable

Stable

Author: Ashley-Kapaso

.github/workflows/backend-tests.yml

@@ -11,7 +11,7 @@ on:
 
 jobs:
   build:
-    name: Run ESLint
+    name: Run Backend tests
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -25,7 +25,7 @@ jobs:
         run: bun install
         working-directory: src/server/workspace
       - name: Run Backend Tests
-        run: bun run test
+        run: bun run test:cov
         working-directory: src/server/workspace
       - name: Upload coverage reports to Codecov
         uses: codecov/[email protected]

.github/workflows/frontend-tests.yml

@@ -0,0 +1,36 @@
+name: Run Frontend Tests
+on:
+    push:
+      branches:
+        - main
+        - develop
+    pull_request:
+      branches:
+        - main
+        - develop
+    
+jobs:
+  build:
+    name: Frontend tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18.17.0
+      - uses: oven-sh/setup-bun@v1
+        with:
+            bun-version: latest
+      - name: Install dependencies for the frontend
+        run: bun install
+        working-directory: src/client
+      - name: Boot frontend
+        run: bash boot.sh
+        working-directory: scripts
+      - name: Run Frontend Tests
+        run: npm run cy:run-ct
+        working-directory: src/client
+      - name: Upload coverage reports to Codecov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/linter.yml

@@ -32,4 +32,4 @@ jobs:
         working-directory: src/client
       - name: Run Backend Linters
         run: bun run lint
-        working-directory: src/server/workspace
+        working-directory: src/server/workspace

README.md

@@ -27,23 +27,16 @@ is revolutionising education by making learning more immersive and engaging.
 
 #### Main Documentation
 
-- [SRS Documentation](#)
-- [Software Architectures](#)
+- [SRS Documentation](https://drive.google.com/file/d/1wYVm633sFN6IBOVznN6bsqExY96VErcM/view?usp=sharing)
+- [Services Contract](https://drive.google.com/file/d/1WEbWfYYVXaN96uxKSO9148U9itmog2K2/view?usp=sharing)
 
-#### Extra Documentation
-
-- [Coding Standards](#)
-- [Testing Policy](#)
-- [Development Diagram](#)
-- [Installation Manual](#)
-- [User Manuals](#)
 
 ### Demos
 
 #### Demo 1
 
-- [Demo 1 Slides](#)
-- [Demo 1 Video](#)
+- [Demo 1 Slides](https://docs.google.com/presentation/d/1L8ZY2dsLOlN_DjLjXGGN0u27xAqYxq00/edit?usp=sharing&ouid=106314516968758648353&rtpof=true&sd=true)
+- [Demo 1 Video](https://drive.google.com/file/d/1AJAgftIAKCBaGVa4KQGHvoX01R3dvBUb/view?usp=sharing)
 
 ### Technologies
 
@@ -55,7 +48,7 @@ is revolutionising education by making learning more immersive and engaging.
 
 ### Project Management
 
-[Project Board](#)
+[Project Board](https://github.com/orgs/COS301-SE-2024/projects/80)
 
 ### Team Members And Their Roles
 

scripts/boot.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+# Start up the frontend
+cd ../src/client || exit
+bun run dev &
+
+# Store the process ID (PID) of the server
+next_pid=$!
+
+# Wait for the server to start up
+while ! curl -s http://localhost:5173 > /dev/null
+do
+  echo "Waiting for server to start up..."
+  sleep 1
+done
+
+sleep 10
+
+echo "Server has started."

src/client/.eslintrc.cjs

@@ -27,5 +27,18 @@ module.exports = {
 				parser: '@typescript-eslint/parser'
 			}
 		}
-	]
+	],
+	rules: {
+		'@typescript-eslint/no-explicit-any': 'off',
+		'@typescript-eslint/ban-types': [
+			'error',
+			{
+				extendDefaults: true,
+				types: {
+					'{}': false
+				}
+			}
+		],
+		'@typescript-eslint/no-namespace': 'off'
+	}
 };

src/client/.prettierrc

@@ -3,6 +3,6 @@
 	"singleQuote": true,
 	"trailingComma": "none",
 	"printWidth": 100,
-	"plugins": ["prettier-plugin-svelte"],
+	"plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"],
 	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
 }

src/client/bun.lockb

@@ -0,0 +1,15 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+	component: {
+		devServer: {
+			framework: 'svelte',
+			bundler: 'vite'
+		},
+		typescript: {
+			configFile: './tsconfig.json'
+		}
+	},
+
+	e2e: {}
+});

src/client/cypress.config.ts

@@ -0,0 +1,22 @@
+describe('Activities page', () => {
+	it('displays the heading', () => {
+		cy.visit('http://localhost:5173/activities');
+		cy.get('h1').contains('Activities').should('be.visible');
+	});
+
+	const activities = [
+		'Budget Planning Meeting',
+		'Faculty Evaluation',
+		'Student Affairs Committee',
+		'Campus Safety Review',
+		'Strategic Planning Workshop',
+		'Alumni Networking Event'
+	];
+
+	activities.forEach((activity) => {
+		it(`displays the activity: ${activity}`, () => {
+			cy.visit('http://localhost:5173/activities');
+			cy.contains(activity).should('be.visible');
+		});
+	});
+});

src/client/cypress/e2e/act.cy.ts

@@ -0,0 +1,16 @@
+describe('Admins page', () => {
+	it('displays the heading', () => {
+		cy.visit('http://localhost:5173/admins');
+		cy.get('h2').contains('Admins').should('be.visible');
+	});
+
+	it('displays the button', () => {
+		cy.visit('http://localhost:5173/admins');
+		cy.get('button').should('be.visible');
+	});
+
+	it('displays the search input', () => {
+		cy.visit('http://localhost:5173/admins');
+		cy.get('input[type="text"]').should('be.visible');
+	});
+});

src/client/cypress/e2e/adm.cy.ts

@@ -0,0 +1,15 @@
+describe('Announcements page', () => {
+	it('displays the heading', () => {
+		cy.visit('http://localhost:5173/announcements');
+		cy.get('h1').contains('Announcements').should('be.visible');
+	});
+
+	const announcements = ['Campus Safety Drill', 'New Library Hours', 'Guest Lecture Series'];
+
+	announcements.forEach((announcement) => {
+		it(`displays the announcement: ${announcement}`, () => {
+			cy.visit('http://localhost:5173/announcements');
+			cy.contains(announcement).should('be.visible');
+		});
+	});
+});

src/client/cypress/e2e/ann.cy.ts

@@ -0,0 +1,28 @@
+describe('Degree Dashboard page', () => {
+	it('displays the heading', () => {
+		cy.visit('http://localhost:5173');
+		cy.get('h1').contains('Degree Dashboard').should('be.visible');
+	});
+
+	const degrees = [
+		'BEng Mechanical Engineering',
+		'BEng Electrical Engineering',
+		'BEng Civil Engineering',
+		'BSc Computer Science',
+		'BEng Chemical Engineering',
+		'BSc Information Technology',
+		'MEng Industrial Engineering',
+		'MEng Mechanical Engineering',
+		'MEng Electrical Engineering',
+		'MSc Computer Science',
+		'PhD Civil Engineering',
+		'PhD Information Technology'
+	];
+
+	degrees.forEach((degree) => {
+		it(`displays the degree: ${degree}`, () => {
+			cy.visit('http://localhost:5173');
+			cy.contains(degree).should('be.visible');
+		});
+	});
+});

src/client/cypress/e2e/hm.cy.ts

@@ -0,0 +1,16 @@
+describe('Lecturers page', () => {
+	it('displays the heading', () => {
+		cy.visit('http://localhost:5173/lecturers');
+		cy.get('h2').contains('Lecturers').should('be.visible');
+	});
+
+	it('displays the button', () => {
+		cy.visit('http://localhost:5173/lecturers');
+		cy.get('button').should('be.visible');
+	});
+
+	it('displays the search input', () => {
+		cy.visit('http://localhost:5173/lecturers');
+		cy.get('input[type="text"]').should('be.visible');
+	});
+});

src/client/cypress/e2e/lec.cy.ts

@@ -0,0 +1,11 @@
+describe('Organisation page', () => {
+	it('displays the heading', () => {
+		cy.visit('http://localhost:5173/organisation');
+		cy.get('h2').contains('Organisation').should('be.visible');
+	});
+
+	it('displays the button', () => {
+		cy.visit('http://localhost:5173/organisation');
+		cy.get('button').should('be.visible');
+	});
+});

src/client/cypress/e2e/org.cy.ts

@@ -0,0 +1,16 @@
+describe('Students page', () => {
+	it('displays the heading', () => {
+		cy.visit('http://localhost:5173/students');
+		cy.get('h2').contains('Students').should('be.visible');
+	});
+
+	it('displays the button', () => {
+		cy.visit('http://localhost:5173/students');
+		cy.get('button').should('be.visible');
+	});
+
+	it('displays the search input', () => {
+		cy.visit('http://localhost:5173/students');
+		cy.get('input[type="text"]').should('be.visible');
+	});
+});

src/client/cypress/e2e/stu.cy.ts

@@ -0,0 +1,5 @@
+{
+	"name": "Using fixtures to represent data",
+	"email": "[email protected]",
+	"body": "Fixtures are a great way to mock data for responses to routes"
+}

src/client/cypress/fixtures/example.json

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

src/client/cypress/support/commands.ts

@@ -0,0 +1,12 @@
+<!doctype html>
+<html>
+	<head>
+		<meta charset="utf-8" />
+		<meta http-equiv="X-UA-Compatible" content="IE=edge" />
+		<meta name="viewport" content="width=device-width,initial-scale=1.0" />
+		<title>Components App</title>
+	</head>
+	<body>
+		<div data-cy-root></div>
+	</body>
+</html>

src/client/cypress/support/component-index.html

@@ -0,0 +1,39 @@
+// ***********************************************************
+// This example support/component.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands';
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')
+
+import { mount } from 'cypress/svelte';
+
+// Augment the Cypress namespace to include type definitions for
+// your custom command.
+// Alternatively, can be defined in cypress/support/component.d.ts
+// with a <reference path="./component" /> at the top of your spec.
+declare global {
+	namespace Cypress {
+		interface Chainable {
+			mount: typeof mount;
+		}
+	}
+}
+
+Cypress.Commands.add('mount', mount);
+
+// Example use:
+// cy.mount(MyComponent)