[CS2103-T14-4] AgentAssist

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,51 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,14 +1,10 @@
-[![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/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-T14-4/tp/actions)
 
-![Ui](docs/images/Ui.png)
+![Ui](docs/images/UiSplitViewWithChart.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/#contributing-to-se-edu) for more info.
+* This is a project done by Software Engineering (SE) students.<br>
+* The project is an adaptation of an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
+* This is **written in OOP fashion**.
+* This is named `AgentAssist` (`AA` for short) because this is designed to help Banking Agents manage the contact details of its clients.
+* For the detailed documentation of this project, see the **[AgentAssist Product Website](https://ay2425s1-cs2103t-t14-4.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -16,6 +16,10 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+run {
+    enableAssertions = true
+}
+
 checkstyle {
     toolVersion = '10.2'
 }
@@ -41,6 +45,7 @@ task coverage(type: JacocoReport) {
 }
 
 dependencies {
+//    classpath "com.github.johnrengelman.shadow:7.1.2"
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '17.0.7'
 
@@ -56,17 +61,31 @@ 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-media' , version:javaFxVersion, classifier: 'win'
 
     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
+    implementation 'org.kordamp.ikonli:ikonli-core:12.3.0'
+    implementation group: 'org.kordamp.ikonli', name: 'ikonli-fontawesome5-pack', version: '12.3.1'
+    implementation 'org.kordamp.ikonli:ikonli-javafx:12.3.1'
 
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
+
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'AgentAssist.jar'
+    zip64 = true
+    exclude('**/META-INF/*.SF', '**/META-INF/*.DSA', '**/META-INF/*.RSA')
+    exclude('**/*.md') // Markdown files
+    exclude('**/*.txt') // Text files
+    exclude('**/docs/**')
+    exclude('**/src/test/**')
+}
+task analyzeJar(type: Copy) {
+    from(zipTree(file('build/libs/AgentAssist.jar')))
+    into 'build/analyzedJar'
 }
-
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,56 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+You can reach us at the email `agentassist@comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Colin Hia
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/colinhia.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/colinhia)]
+[[portfolio](http://github.com/colinhia)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Deliverables & Deadlines, Testing
 
-### Jane Doe
+### Litchiowong Napassorn
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/iamdiluxedbutcooler.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/iamdiluxedbutcooler)]
+[[portfolio](https://www.linkedin.com/in/plengnaps/)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Documentation, Testing
 
-### Johnny Doe
+### Tan Le Yew
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/itsme-zeix.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/itsme-zeix)]
+[[portfolio](http://github.com/itsme-zeix)]
 
-* Role: Developer
-* Responsibilities: Data
+- Role: Developer
+- Responsibilities: Scheduling & Tracking, Integration
 
-### Jean Doe
+### Fiona Qiu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/fionaqy.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/FionaQY)]
+[[portfolio](https://github.com/FionaQY)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Code Quality
 
-### James Doe
+### Shun Ren
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zshunren.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/ZShunRen)]
+[[portfolio](https://zshunren.github.io/)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Testing, Integration

docs/DevOps.md

@@ -19,7 +19,7 @@ Given below are how to use Gradle for some important project tasks.
 * **`clean`**: Deletes the files created during the previous build tasks (e.g. files in the `build` folder).<br>
   e.g. `./gradlew clean`
 
-* **`shadowJar`**: Uses the ShadowJar plugin to creat a fat JAR file in the `build/lib` folder, *if the current file is outdated*.<br>
+* **`shadowJar`**: Uses the ShadowJar plugin to create a fat JAR file in the `build/lib` folder, *if the current file is outdated*.<br>
   e.g. `./gradlew shadowJar`.
 
 * **`run`**: Builds and runs the application.<br>