[CS2103T-T09-2] CodeContact

.github/workflows/gradle.yml

@@ -1,12 +1,12 @@
 name: Java CI
 
-on: [push, pull_request]
+on: [ push, pull_request ]
 
 jobs:
   build:
     strategy:
       matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
+        platform: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.platform }}
 
     steps:
@@ -23,7 +23,7 @@ jobs:
 
       - name: Run repository-wide tests
         if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/.github
+        working-directory: ${{ github.workspace }}/.github
         run: ./run-checks.sh
 
       - name: Validate Gradle Wrapper

ClientRoles.txt

@@ -0,0 +1,4 @@
+Manager
+Developer
+HR
+Client

DeveloperRoles.txt

@@ -0,0 +1,3 @@
+Frontend Developer
+Backend Developer
+Developer

LICENSE

@@ -2,11 +2,11 @@ MIT License
 
 Copyright (c) 2016 Software Engineering Education - FOSS Resources
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Permission is hereby granted, free of charge, to any developer obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
+copies of the Software, and to permit developers to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all

README.md

@@ -1,14 +1,28 @@
-[![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-T09-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T09-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.
+**CodeContact is a desktop application for managing your employee details in a software company.** While it has a GUI,
+most of the user interactions happen using a CLI (Command Line Interface).<br>
+
+Example usages:
+
+* An HR of a software company can easily access the contact information of all employees so that he/she can quickly
+  communicate with them regarding HR-related matters.
+* The project manager can use it to maintain a list of project collaborators and their contact information so that
+  he/she can quickly assemble teams for new projects.
+* A basic developer in a software company can view the positions and roles of everyone in the contact list so that
+  he/she knows who to look for when needing some help.
+
+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 `CodeContact` (`CC` for short).
+* For the detailed documentation of this project, see the *
+  *[Code Contact Product Website](https://ay2324s1-cs2103t-t09-2.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+  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.

build.gradle

@@ -4,6 +4,7 @@ plugins {
     id 'com.github.johnrengelman.shadow' version '7.1.2'
     id 'application'
     id 'jacoco'
+    id 'org.openjfx.javafxplugin' version '0.0.13'
 }
 
 mainClassName = 'seedu.address.Main'
@@ -16,6 +17,11 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+javafx {
+    version = "17.0.7"
+    modules = ['javafx.controls', 'javafx.fxml']
+}
+
 checkstyle {
     toolVersion = '10.2'
 }
@@ -43,7 +49,8 @@ task coverage(type: JacocoReport) {
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '17.0.7'
-
+    implementation group: 'com.azure.tools', name: 'azure-sdk-build-tool', version: '1.0.0'
+    implementation group: 'org.controlsfx', name: 'controlsfx', version: '11.1.2'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
@@ -63,10 +70,16 @@ dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+    // https://mvnrepository.com/artifact/org.controlsfx/controlsfx
+
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'CodeContact.jar'
 }
 
 defaultTasks 'clean', 'test'
+
+run {
+    enableAssertions = true
+}