Merge branch 'master' of https://github.com/shunjieee/tp

* 'master' of https://github.com/shunjieee/tp: (35 commits)
  Update UG
  Add Future Integrations section
  Fix minor bug
  Update test files for CI
  Remove bin files
  rm tests
  commit
  p
  ghi
  Update UG
  gh
  g
  e
  f
  Fix style issues
  Update UG for logout
  Add Export Functionality
  Update Images due to UI improvements
  Update UG for login and register
  Fix checkstyle issues
  ...

.gitignore

@@ -22,3 +22,4 @@ src/test/data/sandbox/
 .DS_Store
 docs/_site/
 docs/_markbind/logs/
+settings.json

build.gradle

@@ -60,6 +60,9 @@ dependencies {
     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'
 
+    implementation group: 'org.json', name: 'json', version: '20180813'
+    implementation group: 'commons-io', name: 'commons-io', version: '2.8.0'
+
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion

docs/AboutUs.md

@@ -15,6 +15,6 @@ Feel free to reach out to us at our organisation's [GitHub](https://github.com/A
 |:--- |:--------------------------------------------------|:--- |:--- |:--- |:--- |
 | Chua Zen Khoon | <img src="images/chuazenkhoon.png" width="200px"> | Y2 CS student. I do creative works such as writing and worldbuilding in my free time! | Project Planner | Deliverables and Deadlines, Scheduling and Tracking | [[github](http://github.com/ChuaZenKhoon)] |
 | Lee Shun Jie | <img src="images/shunjieee.png" width="200px">    | Y2 CS student. I like to travel and explore the world! | Developer | UI |  [[github](http://github.com/shunjieee)] |
-| Oliver James Tan | <img src="images/tcjazwei.png" width="200px">     | Y2 CS student. I read, write, and live in your walls | Developer | User Guide, UI | [[github](httpsL//github.com/tcjazwei)] |
+| Oliver James Tan | <img src="images/team/tcjazwei.png" width="200px">     | Y2 CS student. I read, write, and live in your walls | Developer | User Guide, UI, Additional Functionalities | [[github](httpsL//github.com/tcjazwei)] |
 | Liu Jiayao | <img src="images/ljy0422.png" width="200px">      | Y2 CS student. I like travelling, music and anime. Recently I am enchanted with Chiikawa! | Developer | Functionalities | [[github](https://github.com/ljy0422)] |
 | Shanyl Ong | <img src="images/shanylong.png" width="200px">    | Y2 CS student. I like reading and engaging in nature photography! | Developer | UI, Additional Functionalities | [[github](http://github.com/ShanylOng)] |

docs/UserGuide.md

@@ -16,6 +16,7 @@
 - [FAQ](#faq)
 - [Known Issues](#known-issues)
 - [Command Summary](#command-summary)
+- [Future Integrations](#future-integrations)
 - [Support and Feedback](#support-and-feedback)
 
 ## Welcome Note
@@ -192,7 +193,7 @@ Format: `help`
   </box>
   (The Initial UI before deletion)
 
-  <img src="images/ui/delete/beforeDelete.png" width="452.5" height="369.5"><br>
+  <img src="images/ui/delete/beforeDelete.png" width="452.5"><br>
 
   * **Confirmation of Contact Deletion**<br>
 
@@ -298,90 +299,249 @@ GUI upon successful addition command <br><br>
 
 </panel>
 
-<panel header="### Undo" peek>
+<panel header="### Toggle display: <code>$</code>" peek>
+  Toggle display to view / hide the addressbook.<br><br>
 
-  Restores the address book to the state before the previous **undoable** command was executed.<br>
+  Format: <code>$</code><br>
 
-  <box type="important" seamless>
+  <box type="definition">
+    Viewing addressbook.<br><br>
+    <img src="images/ui/toggle/view.png" width="452.5" height="369.5"><br><br>
+  </box>
 
-  * This command can only be used by clicking in the `edit` section of the menu bar. Typing the command `undo` in the command box will not work. <br><br>
-  * Undoable commands: those commands that modify the address book’s content (add, delete, edit and clear).
+  <box type="definition" theme="info">
+    Hiding addressbook.<br><br>
+    <img src="images/ui/toggle/hide.png" width="452.5" height="369.5"><br><br>
   </box>
 
-  Example:<br>
-  1. Delete the person with the id `johndoe41`.<br>
-  2. Undo the deletion. The person will reappear.<br><br>
-     <img src="images/ui/delete/placeholder.png" width="452.5" height="369.5"><br>
+</panel>
+
+<panel header="### List: <code>ls</code>" peek>
+  List has different functionalities.<br><br>
+
+  Format: <code>ls ARGS</code><br>
+
+  <code>ARGS</code> = <code>-a</code>: List all contacts in the address book. <br>
+  <code>ARGS</code> = <code>-t</code>: List all tags available. <br>
+  <code>ARGS</code> = <code>TAG_NAME</code>: List all contacts with <code>TAG_NAME</code>. <br>
+
+</panel>
+
+<panel header="### Add Tag: <code>tag+</code>" peek>
+  Add tag into a tag list.<br><br>
+
+  Format: <code>tag+ TAG_NAME</code><br>
+
+  <box type="important">
+
+* **MUST** add a tag into a tag list before adding a person.
+
+  </box>
+
+  </panel>
+
+  <panel header="### Delete Tag: <code>tag-</code>" peek>
+  Delete tag from the tag list.<br><br>
+
+  Format: <code>tag- TAG_NAME</code><br>
+
+  <box type="important">
+
+  Tag cannot be removed if a person is tagged with the tag-to-be-removed.
+
+  </box>
+
+  </panel>
 
- * **Confirmation of Successful Undo**<br>
+<panel header="### Undo: <code>undo</code> " peek>
 
-   If there is still any executed command that can be undone, a graphical user interface (GUI) indicative of a successful undo will be displayed, as illustrated below.<br>
+Restores the address book to the state before the previous **undoable** command was executed.<br>
+Format: `undo`<br>
+<box type="important" seamless>
+
+* This command can also be used by clicking in the `edit` section of the menu bar.  <br><br>
+* Undoable commands: those commands that modify the address book’s content (add, delete, edit and clear).
+  </box>
+
+Example:<br>
+1. Delete the person with the id `johndoe41`.<br>
+2. Undo the deletion. The person will reappear.<br><br>
+
+* **Confirmation of Successful Undo**<br>
+
+  If there is still any executed command that can be undone, a graphical user interface (GUI) indicative of a successful undo will be displayed, as illustrated below.<br>
 
   <box type="success">
     GUI upon successful undo command <br><br>
-    <img src="images/ui/delete/placeholder.png" width="452.5" height="369.5"><br>
+    <img src="images/ui/undo/1.png" width="452.5"><br>
   </box> 
 
 * **Error Handling Protocols**<br>
 
-  1. No Undoable Command Error: If there is no more executed command that can be undone, an error will be triggered.<br>
-      <box type="wrong">
-      No undoable command error <br><br>
-      <img src="images/ui/delete/placeholder.png" width="452.5" height="369.5"><br><br>
-      </box>
-</panel>
+    1. No Undoable Command Error: If there is no more executed command that can be undone, an error will be triggered.<br>
+       <box type="wrong">
+       No undoable command error <br><br>
+       <img src="images/ui/undo/2.png" width="452.5" ><br><br>
+       </box>
+       </panel>
 
-<panel header="### Redo" peek>
+<panel header="### Redo: <code>redo</code>" peek>
 
 Reverses the most recently undone command.<br>
+Format: `redo`<br>
 
   <box type="important" seamless>
 
-* This command can only be used by clicking in the `edit` section of the menu bar. Typing the command `redo` in the command box will not work. <br>
-  
+* This command can also be used by clicking in the `edit` section of the menu bar. Typing the command `redo` in the command box will not work. <br>
+
   </box>
 Example:<br>
 1. Delete the person with the id `johndoe41`.<br>
 2. Undo the deletion. The person will reappear.<br>
 3. Redo the undone deletion. The person will be deleted again.<br><br>
-   <img src="images/ui/delete/placeholder.png" width="452.5" height="369.5"><br>
 
 * **Confirmation of Successful Redo**<br>
 
   If there is still any undone command that can be redone, a graphical user interface (GUI) indicative of a successful redo will be displayed, as illustrated below.<br>
 
   <box type="success">
     GUI upon successful redo command <br><br>
-    <img src="images/ui/delete/placeholder.png" width="452.5" height="369.5"><br>
+    <img src="images/ui/redo/1.png" width="452.5" ><br>
   </box> 
 
 * **Error Handling Protocols**<br>
 
     1. No Redoable Command Error: If there is no more undone command that can be redone, an error will be triggered.<br>
        <box type="wrong">
        No redoable command error <br><br>
-       <img src="images/ui/delete/placeholder.png" width="452.5" height="369.5"><br><br>
+       <img src="images/ui/redo/2.png" width="452.5" ><br><br>
        </box>
        </panel>
 
+<panel header="### Register: <code>register</code> " peek>
 
-<panel header="### Toggle display: <code>$</code>" peek>
-  Toggle display to view / hide the addressbook.<br><br>
+Register an account first to have your own address book!<br><br>
+Format: `register /u (username) /p (password)`<br><br>
+Example: `register /u johndoe /p 123456`<br>
 
-  Format: <code>$</code><br>
+  <box type="important" seamless>
 
-  <box type="definition">
-    Viewing addressbook.<br><br>
-    <img src="images/ui/toggle/view.png" width="452.5" height="369.5"><br><br>
+* This command can also be used by clicking in the `Account` section of the menu bar.  <br><br>
+* A valid password is between 6 and 20 characters long and does not contain spaces. <br><br>
+* A valid username should be alphanumeric and between 4 and 10 characters long. <br><br>
+* Usernames are unique and cannot be duplicated.  <br>
   </box>
 
-  <box type="definition" theme="info">
-    Hiding addressbook.<br><br>
-    <img src="images/ui/toggle/hide.png" width="452.5" height="369.5"><br><br>
+**Confirmation of Successful Registration**<br>
+
+  If the user registers successfully, a graphical user interface (GUI) indicative of a successful registration will be displayed, as illustrated below.<br>
+
+  <box type="success">
+    GUI upon successful register command <br><br>
+    <img src="images/ui/register/1.png" width="452.5" ><br>
+  </box> 
+
+* **Error Handling Protocols**<br>
+
+    1. Duplicate username Error: Entry of a non-unique username will trigger an error.<br>
+       <box type="wrong">
+       Duplicate username error <br><br>
+       <img src="images/ui/register/2.png" width="452.5" ><br><br>
+       </box>
+    2. Incomplete Fields Error: Failure to complete all required fields will trigger an error.<br>
+       <box type="wrong">
+       Incomplete fields error <br><br>
+       <img src="images/ui/register/3.png" width="452.5" ><br><br>
+       </box>
+    3. Invalid Fields Error: Any input field violating the requirements mentioned above will trigger an error.
+       <box type="wrong">
+       Invalid fields error <br><br>
+
+        * Invalid username
+
+       <img src="images/ui/register/4.png" width="452.5"><br><br>
+
+        * Invalid password
+
+       <img src="images/ui/register/5.png" width="452.5"><br><br>
+       </box>
+       </panel>
+
+<panel header="### Login: <code>login</code> " peek>
+
+Login to access your addressbook. <br><br>
+Format: `login /u (username) /p (password)`<br><br>
+Example: `login /u johndoe /p 123456`<br>
+
+  <box type="important" seamless>
+
+* This command can also be used by clicking in the `Account` section of the menu bar.  <br><br>
+* A valid password is between 6 and 20 characters long and does not contain spaces. <br><br>
+* A valid username should be alphanumeric and between 4 and 10 characters long. <br><br>
   </box>
 
-</panel>
+**Confirmation of Successful Login**<br>
+
+If the user Logins successfully, a graphical user interface (GUI) indicative of a successful login will be displayed, as illustrated below.<br>
+
+  <box type="success">
+    GUI upon successful login command <br><br>
+    <img src="images/ui/login/success.png" width="452.5" height="369.5"><br>
+  </box> 
+
+* **Error Handling Protocols**<br>
+
+    1. Incomplete Fields Error: Failure to complete all required fields will trigger an error.<br>
+       <box type="wrong">
+       Incomplete fields error <br><br>
+       <img src="images/ui/login/1.png" width="452.5"><br><br>
+       </box>
+    2. Invalid Fields Error: Any input field violating the requirements mentioned above will trigger an error.<br>
+       <box type="wrong">
+       Invalid fields error <br><br>
+
+        * Invalid username
+
+       <img src="images/ui/login/2.png" width="452.5"><br><br>
+
+        * Invalid password
+
+       <img src="images/ui/login/3.png" width="452.5"><br><br>
+       </box>
+    3. Incorrect Username or Password Error: If the username or password is incorrect, an error will be triggered.<br>
+       <box type="wrong">
+       Incorrect username or password error <br><br>
+       <img src="images/ui/login/4.png" width="452.5"><br><br>
+       </box>
+    4. Already Logged In Error: If the user is already logged in, he cannot log in again.<br>
+       <box type="wrong">
+       Already logged in error:<br><br>
+       <img src="images/ui/login/5.png" width="452.5" ><br><br>
+       </box>
+     </panel>
+
+<panel header="### Logout: <code>logout</code> " peek>
+
+After you end accessing your addressbook, log out to protect the data. <br><br>
+Format: `logout`<br><br>
+
+**Confirmation of Successful Logout**<br>
+
+If the user Logouts successfully, a graphical user interface (GUI) indicative of a successful logout will be displayed, as illustrated below.<br>
 
+  <box type="success">
+    GUI upon successful logout command <br><br>
+    <img src="images/ui/logout/success.png" width="452.5" height="369.5"><br>
+  </box> 
+
+* **Error Handling Protocols**<br>
+
+    1. Not Logged Error: If the user hasn't logged in, he cannot log out.<br>
+       <box type="wrong">
+       Not Logged Error:<br><br>
+       <img src="images/ui/logout/notloggederror.png" width="452.5" ><br><br>
+       </box>
+       </panel>
 <!--
 
 ### Listing all persons : `list`
@@ -548,6 +708,21 @@ Action     | Format
 
 ***
 
+## Future Integrations
+
+[back to top](#table-of-contents)
+
+**In the future, we plan to integrate some of the following features:**
+
+1. **A more rigorous account management system**, which will allow us to manage users as an admin, and assign different 
+    levels of authentication or security.
+2. **A remote database management system**, which links all addressbook instances on different machines to the same
+    addressbook database, which will allow for collaboration and other benefits.
+3. **More open-ended tagging and field options**, allowing for the addressbook to be fully customisable as per the
+    organisation's requirements.
+
+***
+
 ## Support and Feedback
 
 [back to top](#table-of-contents)