[CS2103T-F12-2] StudentConnect

.github/workflows/gradle.yml

@@ -22,7 +22,7 @@ jobs:
         run: git checkout --progress --force ${{ github.sha }}
 
       - name: Run repository-wide tests
-        if: runner.os == 'Linux'
+        if: runner.os == 'macOS'
         working-directory:  ${{ github.workspace }}/.github
         run: ./run-checks.sh
 
@@ -39,7 +39,7 @@ jobs:
         run: ./gradlew check coverage
 
       - name: Upload coverage reports to Codecov
-        if: runner.os == 'Linux'
+        if: runner.os == 'macOS'
         uses: codecov/codecov-action@v3
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -1,14 +1,26 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2324S1-CS2103T-F12-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-F12-2/tp/actions)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+### StudentConnect
+
+* This project was created for the **CS2101 Effective Communication for Computing Professionals and CS2103T Software Engineering modules**. <br>
+* It is named `StudentConnect` because it was created to connect students in CS2103T and help with the formation of teams.
+* For the detailed documentation of this project, see the **[StudentConnect GitHub Website](https://github.com/AY2324S1-CS2103T-F12-2/tp)** and **[StudentConnect User Guide](https://ay2324s1-cs2103t-f12-2.github.io/tp/UserGuide.html)**.
+* Value proposition: <br>
+  * `StudentConnect` helps with the **formation of project teams for CS2101/CS2103T**
+  * `StudentConnect` **stores** and **organises students’ contact details, and project group**
+  * Students can **easily search for the profiles of other students** and **connect with potential teammates**
+  * It offers tools for **tracking project progress/deadlines**, ensuring that the group stays on task
+  * There is no other application like `StudentConnect` for **CS2101/CS2103T students**
+
+### Other Links
+* StudentConnect [Main Website](https://ay2324s1-cs2103t-f12-2.github.io/tp/)
+* StudentConnect [User Guide](https://ay2324s1-cs2103t-f12-2.github.io/tp/UserGuide.html)
+* StudentConnect [Developer Guide](https://ay2324s1-cs2103t-f12-2.github.io/tp/DeveloperGuide.html)
+* StudentConnect [About Us Website](https://ay2324s1-cs2103t-f12-2.github.io/tp/AboutUs.html)
+* StudentConnect [Github Website](https://github.com/AY2324S1-CS2103T-F12-2/tp)
+
+### Acknowledgements
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+

build.gradle

@@ -20,7 +20,19 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
+    doFirst {
+        if (System.getProperty("os.name").equals("Linux")) {
+            // FX tests do not successfully run on Ubuntu Runner
+            exclude '**/ui/**'
+            // Excluded because ClearCommand uses FX as well
+            exclude '**/ClearCommandTest.class'
+        }
+    }
     useJUnitPlatform()
     finalizedBy jacocoTestReport
 }
@@ -56,17 +68,26 @@ dependencies {
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-swing', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-swing', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-swing', version: javaFxVersion, classifier: 'linux'
 
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
+    testImplementation 'org.testfx:testfx-core:4.0.16-alpha'
+    testImplementation 'org.testfx:testfx-junit5:4.0.16-alpha'
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
+run {
+    enableAssertions = true
+}
+
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'studentconnect.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,55 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+You can reach us from our [GitHub Website](https://github.com/AY2324S1-CS2103T-F12-2/tp).
 
 ## Project team
 
-### John Doe
+### Pearlynn Toh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/pearlynnt.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/PearlynnT)]
+[[portfolio](team/pearlynnt.md)]
 
-* Role: Project Advisor
+* Role: Team Lead, Developer
 
-### Jane Doe
+### Yik Leong Loo
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/bearypop.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Bearypop)]
+[[portfolio](team/bearypop.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Testing + Integration
 
-### Johnny Doe
+### Chan Wei Ning
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/wnchan.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/wnchan)]
+[[portfolio](team/wnchan.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Documentation
 
-### Jean Doe
+### Alnaseri, Majedah Talal M
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/maj0-0.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/maj0-0)]
+[[portfolio](team/maj0-0.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Deliverables & Deadlines + Scheduling & Tracking
 
-### James Doe
+### Dewangan Neya Praveen
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/neyapraveen.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/neyapraveen)]
+[[portfolio](team/neyapraveen.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Code Quality