diff --git a/docs/AboutUs.md b/docs/AboutUs.md index cfb4ec9d767..62780542b08 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -59,4 +59,4 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` [[portfolio](team/xueting.md)] * Role: Developer -* Responsibilities: UI, FXML, Prototype +* Responsibilities: UI, FXML, Prototype diff --git a/docs/images/choaticman 2.jpg b/docs/images/choaticman 2.jpg new file mode 100644 index 00000000000..6d5271e4fa2 Binary files /dev/null and b/docs/images/choaticman 2.jpg differ diff --git a/docs/team/choaticman 2.md b/docs/team/choaticman 2.md new file mode 100644 index 00000000000..a051d5390a0 --- /dev/null +++ b/docs/team/choaticman 2.md @@ -0,0 +1,46 @@ +--- + layout: default.md + title: "Dylan Chan's Project Portfolio Page" +--- + +### Project: AddressBook Level 3 + +AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **New Feature**: Added the ability to undo/redo previous commands. + * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command. + * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them. + * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands. + * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}* + +* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys. + +* **Code contributed**: [RepoSense link]() + +* **Project management**: + * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub + +* **Enhancements to existing features**: + * Updated the GUI color scheme (Pull requests [\#33](), [\#34]()) + * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]()) + +* **Documentation**: + * User Guide: + * Added documentation for the features `delete` and `find` [\#72]() + * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]() + * Developer Guide: + * Added implementation details of the `delete` feature. + +* **Community**: + * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]() + * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]()) + * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]()) + * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]()) + +* **Tools**: + * Integrated a third party library (Natty) to the project ([\#42]()) + * Integrated a new Github plugin (CircleCI) to the team repo + +* _{you can add/remove categories in the list above}_ diff --git a/src/main/java/seedu/address/model/ReadOnlyHireMe.java b/src/main/java/seedu/address/model/ReadOnlyHireMe.java new file mode 100644 index 00000000000..277fd0e7657 --- /dev/null +++ b/src/main/java/seedu/address/model/ReadOnlyHireMe.java @@ -0,0 +1,16 @@ +package seedu.address.model; + +//import javafx.collections.ObservableList; + +/** + * Unmodifiable view of an address book + */ +public interface ReadOnlyHireMe { + +// /** +// * Returns an unmodifiable view of the intern applications list. +// * This list will not contain any duplicate intern applications. +// */ + //ObservableList getInternshipList(); + +} diff --git a/src/main/java/seedu/address/storage/HireMeStorage.java b/src/main/java/seedu/address/storage/HireMeStorage.java new file mode 100644 index 00000000000..f31d88d2dbf --- /dev/null +++ b/src/main/java/seedu/address/storage/HireMeStorage.java @@ -0,0 +1,26 @@ +package seedu.address.storage; + +import java.io.IOException; +import java.nio.file.Path; +import java.util.Optional; + +import seedu.address.commons.exceptions.DataLoadingException; +import seedu.address.model.ReadOnlyHireMe; + +/** + * Represents a storage for HireMe. + */ +public interface HireMeStorage { + /** + * Returns the file path of the data file. + */ + Path getHireMeFilePath(); + + Optional readHireMe() throws DataLoadingException; + + Optional readHireMe(Path filePath) throws DataLoadingException; + + void saveHireMe(ReadOnlyHireMe hireMe) throws IOException; + + void saveHireMe(ReadOnlyHireMe hireMe, Path filePath) throws IOException; +} diff --git a/src/main/java/seedu/address/storage/JsonAddressBookStorage.java b/src/main/java/seedu/address/storage/JsonAddressBookStorage.java index 41e06f264e1..0668dd97015 100644 --- a/src/main/java/seedu/address/storage/JsonAddressBookStorage.java +++ b/src/main/java/seedu/address/storage/JsonAddressBookStorage.java @@ -31,6 +31,8 @@ public Path getAddressBookFilePath() { return filePath; } + + //To-do: edit this readAddressBook() to read data from data file for HireMe @Override public Optional readAddressBook() throws DataLoadingException { return readAddressBook(filePath);