Skip to content

Commit

Permalink
Merge pull request #89 from COS301-SE-2024/develop
Browse files Browse the repository at this point in the history
Develop to stable
  • Loading branch information
Ashley-Kapaso committed Jun 24, 2024
2 parents 9a4a31f + 1804f3f commit b71f3b6
Show file tree
Hide file tree
Showing 217 changed files with 17,916 additions and 10,720 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/frontend-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
run: bash boot.sh
working-directory: scripts
- name: Run Frontend Tests
run: npm run cy:run-ct
run: npm run test
working-directory: src/client
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v4.0.1
Expand Down
56 changes: 24 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,14 @@
# Phantom Works - ClassConnect

[![ESLint](https://github.com/COS301-SE-2024/ClassConnect/actions/workflows/linter.yml/badge.svg)](https://github.com/COS301-SE-2024/ClassConnect/actions/workflows/linter.yml)
<div align="center">
<h1>ClassConnect</h1>

[![Build Status](https://img.shields.io/badge/Build_Status-GitHub_Actions-brightgreen)](https://github.com/COS301-SE-2024/ClassConnect/actions/workflows/linter.yml)
<img src="./resources/images/class-connect-logo.png" alt="class-connect logo" />

[![Issue Tracking](https://img.shields.io/badge/Issue_Tracking-GitHub_Issues-yellow)](https://github.com/COS301-SE-2024/ClassConnect/issues)
[![Issue Tracking](https://img.shields.io/badge/Issue_Tracking-GitHub_Issues-yellow)](https://github.com/COS301-SE-2024/ClassConnect/issues) [![Build Status](https://img.shields.io/badge/Build_Status-GitHub_Actions-brightgreen)](https://github.com/COS301-SE-2024/ClassConnect/actions/workflows/linter.yml) [![codecov](https://codecov.io/github/COS301-SE-2024/ClassConnect/graph/badge.svg?token=W2cOxCJT1g)](https://codecov.io/github/COS301-SE-2024/ClassConnect) ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m797015486-75c486778a8f87b141372bd7)

[![codecov](https://codecov.io/github/COS301-SE-2024/ClassConnect/graph/badge.svg?token=W2cOxCJT1g)](https://codecov.io/github/COS301-SE-2024/ClassConnect)
</div>

![Uptime Robot status](https://img.shields.io/uptimerobot/status/m797015486-75c486778a8f87b141372bd7)

[![Requirements Status](https://img.shields.io/badge/Requirements-requires.io-orange)](link_to_requires_io)


### Description of ClassConnect
## 📄 Description

ClassConnect is an innovative educational platform that blends the traditional learning
hub with a 3D learning environment. Its primary objective is to leverage cutting-edge
Expand All @@ -23,43 +18,40 @@ This interactive approach not only fosters a deeper understanding of the subject
but also ensures that the learning experience is memorable. In essence, ClassConnect
is revolutionising education by making learning more immersive and engaging.

### Documentation

#### Main Documentation
## 📁 Documentation

- [SRS Documentation](https://drive.google.com/file/d/1wYVm633sFN6IBOVznN6bsqExY96VErcM/view?usp=sharing)
- [Services Contract](https://drive.google.com/file/d/1WEbWfYYVXaN96uxKSO9148U9itmog2K2/view?usp=sharing)
- [SRS Document](https://drive.google.com/file/d/1_EG2l7GWTb_-C0pbum3-EAEQ1Ve1242p/view?usp=sharing)

## 🎬 Demo Video

### Demos

#### Demo 1

- [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
## 🔧 Technologies

<p align="center">
<a href="https://skillicons.dev">
<img src="https://skillicons.dev/icons?i=blender,bun,cypress,fastapi,figma,gcp,jest,mongodb,nextjs,svelte,threejs,vercel&perline=6" />
<img src="https://skillicons.dev/icons?i=aws,svelte,vite,tailwind,threejs,nestjs,bun,mongodb,figma,blender&perline=10" />
</a>
</p>

### Project Management
## 📋 Project Management

[Project Board](https://github.com/orgs/COS301-SE-2024/projects/80)

### Team Members And Their Roles
## 👥 Team Members

| Name | Profile Picture | Role | Socials |
| -------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Joshua Wereley | <img src="./profile-pictures/joshua-profile-picture.jpeg" alt="Joshua's Profile Picture" width="110" height="110"> | Project Manager | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
| Ashley Kapaso | <img src="./profile-pictures/ashley-profile-picture.jpeg" alt="Ashley's Profile Picture" width="110" height="110"> | Architect | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
| Eugene Mpande | <img src="./profile-pictures/eugene-profile-picture.jpeg" alt="Eugene's Profile Picture" width="110" height="110"> | DevOps Engineer | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
| Lunga Ndlovu | <img src="./profile-pictures/lunga-profile-picture.jpeg" alt="Lunga's Profile Picture" width="110" height="110"> | Frontend Engineer | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
| Ayanda Juqu | <img src="./profile-pictures/ayanda-profile-picture.jpeg" alt="Ayanda's Profile Picture" width="110" height="110"> | Backend Engineer | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
| **Joshua Wereley** | <img src="./resources/images/joshua.jpeg" alt="Joshua's Profile Picture" width="200" height="200"> | Project Manager | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
| **Ashley Kapaso** | <img src="./resources/images/ashley.jpeg" alt="Ashley's Profile Picture" width="200" height="200"> | Architect | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
| **Eugene Mpande** | <img src="./resources/images/eugene.jpeg" alt="Eugene's Profile Picture" width="200" height="200"> | DevOps Engineer | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
| **Lunga Ndlovu** | <img src="./resources/images/lunga.jpeg" alt="Lunga's Profile Picture" width="200" height="200"> | Frontend Engineer | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |
| **Ayanda Juqu** | <img src="./resources/images/ayanda.jpeg" alt="Ayanda's Profile Picture" width="200" height="250"> | Backend Engineer | <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=github" alt="GitHub"></a> <a href="#" target="_blank"><img src="https://skillicons.dev/icons?i=linkedin" alt="LinkedIn"></a> |

## ✉️ Contact

### Contact
### phantomworks.capstone@gmail.com

Team Email: <phantomworks.capstone@gmail.com>
<div>
<img src="./resources/images/phantom-works-logo.jpg" alt="phantom-works logo" height="300" width="300"/>
</div>
File renamed without changes
File renamed without changes
Binary file removed resources/images/ayanda.jpg
Binary file not shown.
Binary file added resources/images/class-connect-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file removed resources/images/eugene.jpg
Binary file not shown.
File renamed without changes
File renamed without changes
Binary file added resources/images/phantom-works-logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/video/demo-video.mp4
Binary file not shown.
2 changes: 2 additions & 0 deletions scripts/mongo.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
sudo systemctl start mongod
sudo systemctl status mongod
Binary file modified src/client/bun.lockb
Binary file not shown.
4 changes: 2 additions & 2 deletions src/client/cypress/e2e/act.cy.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
describe('Activities page', () => {
it('displays the heading', () => {
cy.visit('http://localhost:5173/activities');
cy.visit('http://localhost:5173/admin/activities');
cy.get('h1').contains('Activities').should('be.visible');
});

Expand All @@ -15,7 +15,7 @@ describe('Activities page', () => {

activities.forEach((activity) => {
it(`displays the activity: ${activity}`, () => {
cy.visit('http://localhost:5173/activities');
cy.visit('http://localhost:5173/admin/activities');
cy.contains(activity).should('be.visible');
});
});
Expand Down
6 changes: 3 additions & 3 deletions src/client/cypress/e2e/adm.cy.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
describe('Admins page', () => {
it('displays the heading', () => {
cy.visit('http://localhost:5173/admins');
cy.visit('http://localhost:5173/admin/admins');
cy.get('h2').contains('Admins').should('be.visible');
});

it('displays the button', () => {
cy.visit('http://localhost:5173/admins');
cy.visit('http://localhost:5173/admin/admins');
cy.get('button').should('be.visible');
});

it('displays the search input', () => {
cy.visit('http://localhost:5173/admins');
cy.visit('http://localhost:5173/admin/admins');
cy.get('input[type="text"]').should('be.visible');
});
});
4 changes: 2 additions & 2 deletions src/client/cypress/e2e/ann.cy.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
describe('Announcements page', () => {
it('displays the heading', () => {
cy.visit('http://localhost:5173/announcements');
cy.visit('http://localhost:5173/admin/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.visit('http://localhost:5173/admin/announcements');
cy.contains(announcement).should('be.visible');
});
});
Expand Down
4 changes: 2 additions & 2 deletions src/client/cypress/e2e/hm.cy.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
describe('Degree Dashboard page', () => {
it('displays the heading', () => {
cy.visit('http://localhost:5173');
cy.visit('http://localhost:5173/admin');
cy.get('h1').contains('Degree Dashboard').should('be.visible');
});

Expand All @@ -21,7 +21,7 @@ describe('Degree Dashboard page', () => {

degrees.forEach((degree) => {
it(`displays the degree: ${degree}`, () => {
cy.visit('http://localhost:5173');
cy.visit('http://localhost:5173/admin');
cy.contains(degree).should('be.visible');
});
});
Expand Down
6 changes: 3 additions & 3 deletions src/client/cypress/e2e/lec.cy.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
describe('Lecturers page', () => {
it('displays the heading', () => {
cy.visit('http://localhost:5173/lecturers');
cy.visit('http://localhost:5173/admin/lecturers');
cy.get('h2').contains('Lecturers').should('be.visible');
});

it('displays the button', () => {
cy.visit('http://localhost:5173/lecturers');
cy.visit('http://localhost:5173/admin/lecturers');
cy.get('button').should('be.visible');
});

it('displays the search input', () => {
cy.visit('http://localhost:5173/lecturers');
cy.visit('http://localhost:5173/admin/lecturers');
cy.get('input[type="text"]').should('be.visible');
});
});
4 changes: 2 additions & 2 deletions src/client/cypress/e2e/org.cy.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
describe('Organisation page', () => {
it('displays the heading', () => {
cy.visit('http://localhost:5173/organisation');
cy.visit('http://localhost:5173/admin/organisation');
cy.get('h2').contains('Organisation').should('be.visible');
});

it('displays the button', () => {
cy.visit('http://localhost:5173/organisation');
cy.visit('http://localhost:5173/admin/organisation');
cy.get('button').should('be.visible');
});
});
6 changes: 3 additions & 3 deletions src/client/cypress/e2e/stu.cy.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
describe('Students page', () => {
it('displays the heading', () => {
cy.visit('http://localhost:5173/students');
cy.visit('http://localhost:5173/admin/students');
cy.get('h2').contains('Students').should('be.visible');
});

it('displays the button', () => {
cy.visit('http://localhost:5173/students');
cy.visit('http://localhost:5173/admin/students');
cy.get('button').should('be.visible');
});

it('displays the search input', () => {
cy.visit('http://localhost:5173/students');
cy.visit('http://localhost:5173/admin/students');
cy.get('input[type="text"]').should('be.visible');
});
});
Loading

0 comments on commit b71f3b6

Please sign in to comment.