Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add small increments for load feature #51

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Binary file added docs/images/choaticman 2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions docs/team/choaticman 2.md
Original file line number Diff line number Diff line change
@@ -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}_
16 changes: 16 additions & 0 deletions src/main/java/seedu/address/model/ReadOnlyHireMe.java
Original file line number Diff line number Diff line change
@@ -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<InternshipApplication> getInternshipList();

}
26 changes: 26 additions & 0 deletions src/main/java/seedu/address/storage/HireMeStorage.java
Original file line number Diff line number Diff line change
@@ -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<ReadOnlyHireMe> readHireMe() throws DataLoadingException;

Optional<ReadOnlyHireMe> readHireMe(Path filePath) throws DataLoadingException;

void saveHireMe(ReadOnlyHireMe hireMe) throws IOException;

void saveHireMe(ReadOnlyHireMe hireMe, Path filePath) throws IOException;
}
Original file line number Diff line number Diff line change
Expand Up @@ -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<ReadOnlyAddressBook> readAddressBook() throws DataLoadingException {
return readAddressBook(filePath);
Expand Down