From 22af3262be02470651abca6d015b924258dd8855 Mon Sep 17 00:00:00 2001 From: leowyh Date: Thu, 17 Oct 2019 19:08:51 +0800 Subject: [PATCH 1/4] Updated Developer Guide user stories --- docs/DeveloperGuide.adoc | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc index 9de035db11..e0d39bf8f8 100644 --- a/docs/DeveloperGuide.adoc +++ b/docs/DeveloperGuide.adoc @@ -43,8 +43,22 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un |`* * *` |NUS Treasurer |add my deadlines |keep track of the payments to be submitted +|`* * *` |NUS Treasurer |add payees for payments|keep track of the payments made by each payee + +|`* * *` |NUS Treasurer |delete payees who made payments|remove payees whom I do not need to track + +|`* * *` |NUS Treasurer |add payments made by payees|keep track of the payments made by each payee + +|`* * *` |NUS Treasurer |delete payments made by payees|remove payments which I do not need to track + +|`* *` |NUS Treasurer |import files to update my payments made by a payee |do not have to manually input it myself + +|`* *` |NUS Treasurer |export my payments for a project into a statement of accounts |can submit it to my supervisors + |`* *` |NUS Treasurer |set priorities for each deadline |decide which task to finish first +|`* *` |NUS Treasurer |keep track of projects that I am in-charge of |manage the payments for each project + |`* *` |NUS Treasurer |view the amount of money remaining from my budget |budget my spending better |`* *` |NUS Treasurer |edit my forms easily |correct any mistakes i make From 2a60d1db5e3a7f6c1ff64acbae81bad32d3b8a2c Mon Sep 17 00:00:00 2001 From: leowyh Date: Thu, 17 Oct 2019 20:01:52 +0800 Subject: [PATCH 2/4] Updated Developer Guide Setting up --- docs/DeveloperGuide.adoc | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc index e0d39bf8f8..6bdcb92cc7 100644 --- a/docs/DeveloperGuide.adoc +++ b/docs/DeveloperGuide.adoc @@ -16,6 +16,41 @@ endif::[] By: `AY1920S1-CS2113T-F10-3` Since: `Aug 2019` Licence: `NUS` +== Setting up + +=== Prerequisites + +. *JDK `11`* or above +. *IntelliJ* IDE ++ +[NOTE] +IntelliJ by default has Gradle and JavaFx plugins installed. + +Do not disable them. If you have disabled them, go to `File` > `Settings` > `Plugins` to re-enable them. + +=== Setting up the project in your computer + +. Fork this repo, and clone the fork to your computer +. Open IntelliJ (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project dialog first) +. Set up the correct JDK version for Gradle +.. Click `Configure` > `Project Defaults` > `Project Structure` +.. Click `New...` and find the directory of the JDK +. Click `Import Project` +. Locate the `build.gradle` file and select it. Click `OK` +. Click `Open as Project` +. Click `OK` to accept the default settings +. Open a console and run the command `gradlew processResources` (Mac/Linux: `./gradlew processResources`). It should finish with the `BUILD SUCCESSFUL` message. + +This will generate all resources required by the application and tests. + +== Design + +== Implementation + +== Documentation + +== Testing + +== Dev Ops + [appendix] == Product Scope From 371782557b7bee9c6cc3bf4c5a60d50676eb5141 Mon Sep 17 00:00:00 2001 From: leowyh Date: Thu, 17 Oct 2019 20:07:44 +0800 Subject: [PATCH 3/4] Renamed Duke to AlphaNUS --- src/main/java/{Duke.java => AlphaNUS.java} | 16 ++++++++-------- src/main/java/command/Parser.java | 8 ++++---- src/main/java/common/DukeException.java | 8 ++++---- src/main/java/ui/Ui.java | 6 +++--- 4 files changed, 19 insertions(+), 19 deletions(-) rename src/main/java/{Duke.java => AlphaNUS.java} (67%) diff --git a/src/main/java/Duke.java b/src/main/java/AlphaNUS.java similarity index 67% rename from src/main/java/Duke.java rename to src/main/java/AlphaNUS.java index 6f0d97bca9..f8fab52557 100644 --- a/src/main/java/Duke.java +++ b/src/main/java/AlphaNUS.java @@ -7,23 +7,23 @@ import java.util.HashMap; /** - *

Duke

- * Duke is a program that tracks a list of tasks given by the user. + *

AlphaNUS

+ * AlphaNUS is a program that tracks a list of tasks given by the user. * * @author Leow Yong Heng */ -public class Duke { +public class AlphaNUS { private static Ui ui; private static TaskList tasklist; private static Storage storage; private static HashMap managermap; /** - * Creates a Duke instance and initialises the required attributes. + * Creates a AlphaNUS instance and initialises the required attributes. * @param filepath Filepath to the storage. */ - private Duke(String filepath) { + private AlphaNUS(String filepath) { ui = new Ui(); storage = new Storage(filepath); //ArrayList arraylist = storage.load(); <-- Giving file not found exception, to remove @@ -32,7 +32,7 @@ private Duke(String filepath) { } /** - * Method to run the Duke instance and take in the inputs of the user. + * Method to run the AlphaNUS instance and take in the inputs of the user. */ private void run() { ui.startMessage(); @@ -45,10 +45,10 @@ private void run() { } /** - * The main method of the Duke program, which instantiates a duke instance with the filepath to the storage. + * The main method of the AlphaNUS program, which instantiates a AlphaNUS instance with the filepath to the storage. * @param args Unused. */ public static void main(String[] args) { - new Duke("data/duke.txt").run(); + new AlphaNUS("data/AlphaNUS.txt").run(); } } diff --git a/src/main/java/command/Parser.java b/src/main/java/command/Parser.java index 25c6f0cc69..80af31559c 100644 --- a/src/main/java/command/Parser.java +++ b/src/main/java/command/Parser.java @@ -1,6 +1,6 @@ package command; -import common.DukeException; +import common.AlphaNUSException; import common.TaskList; import payment.Payee; import payment.PaymentManager; @@ -29,7 +29,7 @@ public class Parser { * @param ui Ui that interacts with the user. * @param storage Storage for the Tasklist. * @return Returns boolean variable to indicate when to stop parsing for input. - * @throws DukeException if input is not valid. + * @throws AlphaNUSException if input is not valid. */ public static boolean parse(String input, TaskList tasklist, Ui ui, Storage storage, HashMap managermap) { @@ -89,9 +89,9 @@ public static boolean parse(String input, TaskList tasklist, Ui ui, } else if (instr.isDeletePayee(input)) { process.deletePayee(input, managermap, ui); } else { - throw new DukeException(" ☹ OOPS!!! I'm sorry, but I don't know what that means :-("); + throw new AlphaNUSException(" ☹ OOPS!!! I'm sorry, but I don't know what that means :-("); } - } catch (DukeException e) { + } catch (AlphaNUSException e) { ui.exceptionMessage(e.getMessage()); } return false; diff --git a/src/main/java/common/DukeException.java b/src/main/java/common/DukeException.java index 1222b7bd37..80078f99f2 100644 --- a/src/main/java/common/DukeException.java +++ b/src/main/java/common/DukeException.java @@ -1,15 +1,15 @@ package common; /** - * A class for exceptions specific to Duke. + * A class for exceptions specific to AlphaNUS. */ -public class DukeException extends Exception { +public class AlphaNUSException extends Exception { /** - * Creates an instance of an exception specific to duke. + * Creates an instance of an exception specific to AlphaNUS. * @param message Message describing the exception thrown. */ - public DukeException(String message) { + public AlphaNUSException(String message) { super(message); } } diff --git a/src/main/java/ui/Ui.java b/src/main/java/ui/Ui.java index 1bfdfd540f..a13aee315a 100644 --- a/src/main/java/ui/Ui.java +++ b/src/main/java/ui/Ui.java @@ -32,18 +32,18 @@ public String readInput() { } /** - * Prints starting message for the Duke program. + * Prints starting message for the AlphaNUS program. */ public void startMessage() { String logo = line - + " Hello! I'm Duke\n" + + " Hello! I'm AlphaNUS\n" + " What can I do for you?\n" + line; System.out.print(logo); } /** - * Prints ending message for the Duke program. + * Prints ending message for the AlphaNUS program. */ public void byeMessage() { String output = line + " Bye. Hope to see you again soon!\n" + line; From 38c0946bd413d99f01a7f8ac8de7524cf4e4f4dd Mon Sep 17 00:00:00 2001 From: leowyh Date: Fri, 18 Oct 2019 02:39:18 +0800 Subject: [PATCH 4/4] Renamed UI.PNG to Ui.PNG and passed checkstyle --- README.md | 2 +- config/checkstyle/checkstyle.xml | 2 +- docs/images/{UI.PNG => Ui.PNG} | Bin .../{DukeException.java => AlphaNUSException.java} | 0 4 files changed, 2 insertions(+), 2 deletions(-) rename docs/images/{UI.PNG => Ui.PNG} (100%) rename src/main/java/common/{DukeException.java => AlphaNUSException.java} (100%) diff --git a/README.md b/README.md index 2cda3ad336..7977687e91 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # AlphaNUS -![Image_of_Ui](docs/images/UI.PNG) +![Image_of_Ui](docs/images/Ui.PNG) * AlphaNUS is an app intended for the treasurers of NUS clubs. The user interactions will occur using the CLI. * The purpose of the app is to categorize the deadline of the payment forms, expenses of events and history of tasks completed. This allows the treasurer to be organized and efficiently keep track of their tasks. diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml index b1a57ba6c0..318e19e301 100644 --- a/config/checkstyle/checkstyle.xml +++ b/config/checkstyle/checkstyle.xml @@ -189,7 +189,7 @@ - + diff --git a/docs/images/UI.PNG b/docs/images/Ui.PNG similarity index 100% rename from docs/images/UI.PNG rename to docs/images/Ui.PNG diff --git a/src/main/java/common/DukeException.java b/src/main/java/common/AlphaNUSException.java similarity index 100% rename from src/main/java/common/DukeException.java rename to src/main/java/common/AlphaNUSException.java