MineFriends

.github/workflows/gradle.yml

@@ -43,4 +43,4 @@ jobs:
         with:
           directory: ${{ github.workspace }}/build/reports/jacoco/coverage
           files: coverage.xml
-          fail_ci_if_error: true
+          fail_ci_if_error: false

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)
+# Minefriends 👾
 
-![Ui](docs/images/Ui.png)
+[![CI Status](https://github.com/AY2223S1-CS2103T-T10-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S1-CS2103T-T10-4/tp/actions)
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+
+:bulb: Before we begin, it is important to note that:
+* Minefriends is not affiliated with Minecraft, Mojang Studios or Microsoft in any way.
+* Minefriends is an independently developed software. It is not a product owned by Mojang Studios or Microsoft.
+* Team Minefriends do not own Minecraft, in whole or in part.
+
+Minefriends is a **desktop app for avid Minecraft players to manage information about their online friends**. 
+
+With Minefriends, you can:
+
+- Maintain a list of all your online friends
+- Access your friends' information easily, such as their emails and social handles
+- Keep track of which servers and timezones your friends are playing on
 
-* 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.
+
+### Note:
+Minefriends is optimized for use via a Command Line Interface (CLI), while also having the benefits of a Graphical User Interface (GUI).
+
+
+**Download Minefriends and run it now! (- link or jar file to be added -)**
+
+Sample interface:
+![Ui](docs/images/Ui.png)

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.8'
 }
 
 mainClassName = 'seedu.address.Main'
@@ -56,13 +57,27 @@ 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: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-media', 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'
 
+    // https://mvnrepository.com/artifact/org.controlsfx/controlsfx
+    implementation group: 'org.controlsfx', name: 'controlsfx', version: '11.0.3'
+
+    implementation group: 'org.testfx', name: 'testfx-core', version: '4.0.16-alpha'
+
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    testRuntimeOnly group: 'org.testfx', name: 'openjfx-monocle', version: 'jdk-12.0.1+2'
+}
+
+run {
+    enableAssertions = true
 }
 
 shadowJar {

docs/AboutUs.md

@@ -5,55 +5,61 @@ 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 at the email `[email protected]`
 
 ## Project team
 
-### John Doe
+### Zhang Bozheng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zbz-lvlv.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/zbz-lvlv)]
 
-* Role: Project Advisor
+[[portfolio](team/zbz-lvlv.md)]
 
-### Jane Doe
+* Role: Team Lead
+* Responsibilities: All
 
-<img src="images/johndoe.png" width="200px">
+### Kang Wenhan
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/onepersonhere.png" width="200px">
 
-* Role: Team Lead
-* Responsibilities: UI
+[[github](http://github.com/onepersonhere)]
+
+[[portfolio](team/onepersonhere.md)]
 
-### Johnny Doe
+* Role: Co-Lead
+* Responsibilities: Code Quality
 
-<img src="images/johndoe.png" width="200px">
+### Justin Cheng
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+<img src="images/chustinjeng.png" width="200px">
+
+[[github](http://github.com/Chustinjeng)]
+
+[[portfolio](team/chustinjeng.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Functional developer and test cases
 
-### Jean Doe
+### Shawn Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/shawnkai.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/shawnkai)]
+
+[[portfolio](team/shawnkai.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Code Quality
+
+### Sheryl Kong
 
-### James Doe
+<img src="images/sherylkong18.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](http://github.com/sherylkong18)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[portfolio](team/sherylkong18.md)]
 
 * Role: Developer
 * Responsibilities: UI

docs/Configuration.md

@@ -1,6 +1,3 @@
----
-layout: page
-title: Configuration guide
----
+# Configuration guide
 
 Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).

docs/DevOps.md

@@ -1,7 +1,4 @@
----
-layout: page
-title: DevOps guide
----
+# DevOps guide
 
 * Table of Contents
 {:toc}