[CS2113T-T09-1] ConTech

.classpath

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" output="bin/main" path="src/main/java">
+		<attributes>
+			<attribute name="gradle_scope" value="main"/>
+			<attribute name="gradle_used_by_scope" value="main,test"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="bin/test" path="src/test/java">
+		<attributes>
+			<attribute name="gradle_scope" value="test"/>
+			<attribute name="gradle_used_by_scope" value="test"/>
+			<attribute name="test" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-11/"/>
+	<classpathentry kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/>
+	<classpathentry kind="output" path="bin/default"/>
+</classpath>

.gitignore

@@ -13,5 +13,9 @@ src/main/resources/docs/
 *.iml
 bin/
 
-/text-ui-test/ACTUAL.txt
-text-ui-test/EXPECTED-UNIX.TXT
+
+/data/contacts.txt
+/data/me.txt
+# ensure that no existing contact data exists on remote, so that runtest.sh is always on fresh build
+/text-ui-test/data/contacts.txt
+/text-ui-test/data/me.txt

.project

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>tp</name>
+	<comment>Project tp created by Buildship.</comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.buildship.core.gradleprojectbuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+		<nature>org.eclipse.buildship.core.gradleprojectnature</nature>
+	</natures>
+	<filteredResources>
+		<filter>
+			<id>1633538525160</id>
+			<name></name>
+			<type>30</type>
+			<matcher>
+				<id>org.eclipse.core.resources.regexFilterMatcher</id>
+				<arguments>node_modules|.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments>
+			</matcher>
+		</filter>
+	</filteredResources>
+</projectDescription>

.settings/org.eclipse.buildship.core.prefs

@@ -0,0 +1,13 @@
+arguments=
+auto.sync=false
+build.scans.enabled=false
+connection.gradle.distribution=GRADLE_DISTRIBUTION(WRAPPER)
+connection.project.dir=
+eclipse.preferences.version=1
+gradle.user.home=
+java.home=C\:/src/jdk11
+jvm.arguments=
+offline.mode=false
+override.workspace.settings=true
+show.console.view=true
+show.executions.view=true

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.Duke
+

build.gradle

@@ -12,6 +12,21 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
+
+    String javaFxVersion = '11'
+
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'linux'
+    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'
 }
 
 test {
@@ -43,4 +58,6 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
+

data/import.txt

@@ -0,0 +1,6 @@
+ashraf,ashrafjfr,null,null,null,null
+lezai,lezongmun,null,null,null,null
+andre,null
+marcus,null,null,null,null,null
+badgithub,@@github,null,null,null,null
+Le Zong,lezongmun,null,lezongg,null,[email protected]

docs/AboutUs.md

@@ -2,8 +2,9 @@
 
 Display | Name | Github Profile | Portfolio 
 --------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Marcus Ong | [Github](https://github.com/marcusbory) | [Portfolio](marcusbory.github.io/)
+![](https://via.placeholder.com/100.png?text=Photo) | Andre | [Github](https://github.com/ng-andre) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Mun Le Zong | [Github](https://github.com/lezongmun) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Mayank Panjiyara | [Github](https://github.com/mayankp291) | [Portfolio](docs/team/johndoe.md)
+![Ashraf](https://via.placeholder.com/100.png?text=Photo) | Ashraf| [Github](https://github.com/ashrafjfr) | [Portfolio](docs/team/johndoe.md)
+

docs/DeveloperGuide.md

@@ -1,38 +1,229 @@
 # Developer Guide
 
-## Acknowledgements
+### Table of Content
+- [Acknowledgements](#acknowledgements)
+- [Design](#design)
+  - [System Architecture](#sys-arch)
+  - [TextUi](#text-ui)
+  - [MainParser](#main-parser)
+  - [Command](#command)
+  - [ContactList](#contact-list)
+  - [Storage](#storage)
+- [Implementation](#implementation)
+  - [Supported contact details](#supported-details) 
+  - [Adding a contact](#Add)
+  - [Viewing a contact](#View)
+  - [Editing a contact](#Edit)
+  - [Deleting a contact](#Delete)
+  - [Searching a contact](#Search)
+  - [Listing all contacts](#List)
+- [Product Scope](#scope)
+  - [Target user profile](#target)
+  - [Value proposition](#value)
+- [User Stories](#stories)
+- [Non-Function Requirements](#nf-req)
+- [Glossary](#glossary)
+- [Instructions for manual testing](#manual-test)
+
+## <a name="acknowledgements"></a>Acknowledgements
+
+- Inspiration for App Idea and OOP Structure: AddressBook (Level 2) <br />
+  https://github.com/se-edu/addressbook-level2
+- Inspiration for User Guide and Developer Guide: AddressBook (Level 3) <br />
+  https://se-education.org/addressbook-level3/DeveloperGuide.html <br/>
+  https://se-education.org/addressbook-level3/UserGuide.html
+- Converting text for ConTech: <br />
+  https://patorjk.com/software/taag/#p=display&f=Graffiti&t=Type%20Something%20
+- GitHub Markdown Emoji Syntax for User Guide: <br />
+  https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md
+- PlantUML Tutorial: <br />
+  https://se-education.org/guides/tutorials/plantUml.html
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
+## <a name="design"></a>Design
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### <a name="sys-arch"></a>System Architecture
 
+![System Architecture](images/SystemArchitectureDiagram.png)
 
-## Product scope
-### Target user profile
+The above **System Architecture** diagram shows the high-level design of ConTech.
 
-{Describe the target user profile}
+On launch, the `Main` class initialises the app components in the correct sequence and links them up
+with each other, in the correct sequence.
 
-### Value proposition
+ConTech comprises five main components, namely:
+- `TextUi`: Command Line User Interface of ConTech.
+- `MainParser`: Parser to parser user inputs from `TextUi` for `Command`.
+- `Command`: Command to be executed upon input parsing.
+- `ContactList`: Data structure to store `Contact`s while running ConTech.
+- `Storage`: Reads from and writes to [`LocalStorage`](#local-storage).
 
-{Describe the value proposition: what problem does it solve?}
+**How the architecture components interact with each other**
 
-## User Stories
+The five main components interact with each other, as shown in the sequence diagram below
+for the example: `view 2`
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+![Sysem Architecture Sequence Diagram](images/SystemArchitectureSequence.png)
+
+
+### <a name="text-ui"></a>TextUi
+### <a name="main-parser"></a>MainParser
+The `MainParser` component is responsible for making sense of the user's inputs. It functions as the
+not only the identifier for commands, but also calls its relevant sub-parsers to further destructure
+the inputs, allowing ConTech to perform its commands.
+
+The diagram below shows a sequence diagram of how `MainParser` works, and a reference diagram is used
+to indicate that further parsing is done by sub-parsers for each different command type. This reference diagram
+will be referred to later on.
+
+![Main Parser Sequence Diagram](images/MainParserSequenceDiagram.png)
+
+### <a name="command"></a>Command
+### <a name="contact-list"></a>ContactList
+### <a name="storage"></a>Storage
+**API** :`Storage.java`
+
+![Storage Class Diagram](images/StorageClassDiagram.png)
+
+The `Storage` component is responsible for saving both contacts data and personal contact data locally inside the file 
+paths, `data/contacts.txt` and `data/me.txt`. `Storage` is also responsible for loading these data back into their 
+corresponding `ContactList` and `Contact` objects. It is thus dependent on the classes, `ContactList` and 
+`Contact`.
+
+
+## <a name="implementation"></a>Implementation
+
+### <a name="supported-details"></a>Supported Contact Details
+The currently supported contact details are provided in the table below:
+
+|Flag|Detail of contact|
+|----|------|
+|`-n`|Name|
+|`-g`|Github username|
+|`-l`|LinkedIn handle|
+|`-te`|Telegram handle|
+|`-tw`|Twitter handle|
+|`-e`|Email|
+
+### <a name="Add"></a>Adding a contact: `add`
+This feature is processed using `AddContactCommand`. This feature allows a user to add a contact to their contact list.
+The user is able to add a contact by entering a command in the form of `add [DETAILS WITH FLAGS]`, where
+the details with flags are specified in the form `-<flag> <detail>`.
+
+The user's input is parsed in `MainParser` and `AddContactParser`, the latter which inherits `ContactParser`. 
+`ContactParser` inherits `RegexParser` (for regex checks regarding each detail) and implements the `ContactDetails`
+interface (which uniquely allows the parsers to easily identify each detail based on their indexes).
+
+As the contacts are identified by their names, the name field is made compulsory at the `MainParser` level.
+The diagram below shows the process of parsing the user's input.
+
+![Add Contact Parsing](images/AddContactParsingSequenceDiagram.png)
+
+Upon parsing the user's input, the details are passed to an `AddContactCommand`, and this command will be 
+executed in `Duke`. The sequence diagram below illustrates the process of executing `AddContactCommand`.
+
+![Add Sequence Diagram](images/AddContactCommandSequenceDiagram.png)
+
+### <a name="View"></a>Viewing a contact: `view`
+This feature is processed using `ViewContactCommand`. Whenever a user wants to view a specific contact from the 
+contact list, user can input `view [INDEX]` with the index of the desired contact displayed from the `list` feature. 
+`ViewContactCommand` is then created in the `MainParser` and executed in `Duke`.
+The sequence diagram below illustrates the `execute()` function in `ViewContactCommand`.
+
+![View Sequence Diagram](images/ViewContactCommandSequenceDiagram.png)
 
-## Non-Functional Requirements
+### <a name="Edit"></a>Editing a contact: `edit`
+This feature is processed using `EditContactParser` under `MainParser`. In order to edit a contact in the contact list, 
+a user must enter a command in the form `edit [CONTACT INDEX] [DETAILS WITH FLAGS]`, where the details with flags are 
+specified in the form `-<flag> <detail>` with up to 6 details i.e. `-g github-username -tw twitter_handle`. The user 
+input will be parsed by `EditContactParser` methods `getIndexToStore` and `parseContactDetails` to obtain a String 
+array with the details to be edited. An `EditContactCommand` with the specified parameters will then be created and 
+executed in `Duke`. The sequence diagram below shows how the whole process is carried out.
 
+![Edit Sequence Diagram](images/EditContactCommandSequenceDiagram.png)
+
+
+### <a name="Delete"></a>Deleting contacts: `rm`
+This feature is processed using the `DeleteContactCommand`. `DeleteContactCommand` is created 
+in the `MainParser`and executed in`Duke`. Users can either delete a specified contact
+or delete all contacts at once.
+
+![Delete Sequence Diagram](images/DeleteContactCommandSequenceDiagram.png)
+
+To delete all contacts, a user must enter the command `rm all`. The sequence diagram below
+shows how the removal of all contacts works. Before any deletion, the user will be
+prompted with a message to confirm deletion. If the user confirms deletion for all contacts,
+deletion will be executed, along with a message to show that deletion has been executed.
+If user cancels deletion, a message is printed to show that the deletion has been cancelled.
+
+![Delete All Sequence Diagram](images/DeleteAllContacts.png) 
+
+To delete a selected contact, a user must enter a command in the form `rm [INDEX]`. The sequence diagram below
+shows how the removal of a contact works. Before any deletion, details of the contact with the specified`INDEX` 
+will be displayed to the user, along with a prompt to confirm deletion. If the user confirms deletion, 
+deletion of the selected contact will be executed, along with a message to show that deletion has been executed.
+If user cancels deletion, a message is printed to show that the deletion has been cancelled.
+
+![Delete Selected Sequence Diagram](images/DeleteSelectedContact.png)
+
+
+### <a name="Search"></a>Searching a contact: `search`
+This feature is processed using `SearchContactParser` under `MainParser`. In order to edit a contact in the contact list,
+a user must enter a command in the form `search [FLAG] [SEARCH QUERY]`. If no flag is specified, the search will be done
+on contact names buy default. From the user input, the search query and the search flag are obtained from the 
+`parseSearchQuery` and the `getDetailFlag` methods respectively. A `SearchContactCommand` with the specified parameters
+will be created and executed in `Duke`. The sequence diagram below shows how the whole process is carried out.
+
+![Search Sequence Diagram](images/SearchContactCommandSequenceDiagram.png)
+
+
+### <a name="List"></a>Listing all contacts: `ls`
+This feature is processed using `MainParser`. The control is sent to `ListContactsCommand` under `Command` to execute the
+command which uses a loop to get the Contact object at every available index and print it using the `printContactWithIndex`
+function in `TextUi` class.
+
+![List Sequence Diagram](images/ListContactsCommandSequenceDiagram.png)
+
+
+## <a name="scope"></a>Product scope
+### <a name="target"></a>Target user profile
+- Has a need to store a significant amount of computing-related contacts
+- Prefers and is familiar with Command Line Interface (CLI) applications
+- Has many contacts that use common computing platforms, such as: Github, Linkedin, Twitter, Telegram, and Email
+- Can type fast and prefers typing to mouse interactions
+
+### <a name="value"></a>Value proposition
+
+As computing professionals are often on their computer, ConTech allows them to have a platform to 
+manage their computing-related contacts locally and efficiently, without the need to use 
+additional devices or platforms.
+
+## <a name="stories"></a>User Stories
+
+|Version| As a ... | I want to ... | So that I can ...|
+|--------|----------|---------------|------------------|
+|v1.0|programmer|add my colleague's account usernames|easily access it|
+|v1.0|programmer|edit my colleague's account usernames|update it if there is a change|
+|v1.0|programmer|save contact data locally on my hard drive|access it without internet|
+|v1.0|programmer|view various contact details of my colleague|contact him easily on different platforms|
+|v1.0|programmer|see the names and index of saved contacts|know the contacts I have saved|
+|v1.0|programmer|delete a specific contact||
+|v1.0|programmer|be able to copy and paste the displayed contact's URLs|visit the contact's accounts|
+|v2.0|programmer|save my personal details|the application is aware of the user|
+|v2.0|forgetful user|be able to search for my contacts by name|find their contact details|
+|v2.0|programmer|import a list of contacts quickly from an input txt file|save time typing each contact
+
+## <a name="nf-req"></a>Non-Functional Requirements
+
+- Should work on any [*mainstream Operating Systems*](#os) as long as Java `11` or higher has been installed on it
 {Give non-functional requirements}
 
-## Glossary
+## <a name="glossary"></a>Glossary
 
-* *glossary item* - Definition
+* <a name="os"></a>**Mainstream Operating Systems** - Windows, macOS, *NIX
+* <a name="local-storage"></a>**LocalStorage** - Refers to user's hard disk storage
 
-## Instructions for manual testing
+## <a name="manual-test"></a>Instructions for manual testing
 
 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}