[CS2103-F10-3] MODcheck

.gitignore

@@ -12,6 +12,9 @@ src/main/resources/docs/
 /data/
 /config.json
 /preferences.json
+
+/userData.json
+
 /*.log.*
 
 # Test sandbox files

README.md

@@ -1,14 +1,129 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
-
-![Ui](docs/images/Ui.png)
-
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+[![CI Status](https://github.com/AY2223S2-CS2103-F10-3/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2223S2-CS2103-F10-3/tp/actions/workflows/gradle.yml)
+
+
+
+# ModCheck
+ModCheck is a contact management app that enables you to manage all your contacts easily that works on Windows, MacOS and Linux!
+Our app is catered towards fast typist and many features are catered for students that need better management of their contacts.
+
+## Main GUI
+<p align="center">
+<img src="https://raw.githubusercontent.com/AY2223S2-CS2103-F10-3/tp/master/docs/images/Ui.png" align="center" height=auto width="600">
+</p>
+<p align="center">
+<em>Main UI</em>
+</p>
+
+## Key Features
+
+### 👁️ View hidden details of contacts 
+
+ModCheck allows you to view all the details that the contacts have
+
+### ➕ Add new contacts easily
+
+ModCheck can add new contacts quickly and supports many contacts
+
+### 🧹 Clear all existing contacts 
+
+ModCheck can clear all your contacts from the app with just one command!
+
+### ❌ Delete a specific contact
+
+ModCheck allows you to choose which contact to be deleted from the app
+
+### ✍️ Edit a specific contact
+
+ModCheck allows you to edit details of the specified contact
+
+### 🔙 Undo previous changes made in ModCheck
+
+ModCheck can undo all changes that you have made accidentally
+
+### ↩️ Redo what has been undone 
+
+ModCheck also allows you to redo changes made if you have undo accidentally
+
+### ⬇️ Load a new data file 
+
+ModCheck also allows you to quickly load data from another file to ModCheck
+
+### 📦 Export specified contacts for archiving 
+
+ModCheck can export contacts that you want to archive in another place
+
+### 🔦 Toggle between light and dark mode
+
+ModCheck allows you to quickly customize how the overall UI looks!
+
+### 🔍 Filter contacts by name, phone number, description, email address, tags and module tags quickly
+
+ModCheck can quickly filter all your contacts based on the criteria provided
+
+### 💾 Instant saving when changes are made
+
+ModCheck can save all your work immediately on the fly
+
+### ✅ List all contacts quickly without lag
+
+ModCheck can display all your contacts in one go!
+
+## Usage
+
+<div markdown="block" class="alert alert-info">
+
+**:information_source: Notes about the command format:**<br>
+
+* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
+  e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.
+
+* Items in square brackets are optional.<br>
+  e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
+
+* Items with `…`​ after them can be used multiple times including zero times.<br>
+  e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
+
+* Parameters can be in any order.<br>
+  e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
+
+* If a parameter is expected only once in the command but you specified it multiple times, only the last occurrence of the parameter will be taken.<br>
+  e.g. if you specify `p/12341234 p/56785678`, only `p/56785678` will be taken.
+
+* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
+  e.g. if the command specifies `help 123`, it will be interpreted as `help`.
+
+* :warning: Unrecognised fields such as `b/` or `c/` will not be picked up as fields, and will be treated as input.
+
+</div>
+
+## Guides
+
+[User Guide](https://ay2223s2-cs2103-f10-3.github.io/tp/UserGuide.html)
+
+[Developer Guide](https://ay2223s2-cs2103-f10-3.github.io/tp/DeveloperGuide.html)
+
+## FAQ
+
+**Q**: How do I transfer my data to another Computer?<br>
+**A**: Install the app in the other computer. `load` the contents of the previous data file into your new ModCheck.
+
+## Command summary
+
+| Action     | Format, Examples                                                                                                                                                                                                                                                                                                                             |
+|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Add**    | `add n/NAME p/PHONE_NUMBER e/EMAIL d/DESCRIPTION [t/TAG]…​ [m/MODULE_TAG]…​ ` <br> e.g., `add n/Benedict Tan d/Great Friend e/BenedictTan@gmail.com p/98070707 t/Friend m/CS2103 m/CS3230 `                                                                                                                                                  |
+| **View**   | `view INDEX`<br> e.g., `view 2`                                                                                                                                                                                                                                                                                                              |
+| **Clear**  | `clear`                                                                                                                                                                                                                                                                                                                                      |
+| **Delete** | `delete INDEX` or `delete INDEXES` or `delete NAME` <br> e.g., `delete 3` or `delete 1,2,3` or `delete James`                                                                                                                                                                                                                                |
+| **Edit**   | `edit {INDEX or NAME} [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com` or `edit James e/jameslee@example.com`                                                                                                                                                                 |                                                                                                                                                                                                                       |
+| **List**   | `list`                                                                                                                                                                                                                                                                                                                                       |
+| **Help**   | `help`                                                                                                                                                                                                                                                                                                                                       |
+| **Filter** | `filter n/NAME` <br> `filter p/PHONE_NUMBER`<br> `filter e/EMAIL_ADDRESS` <br> `filter d/DESCRIPTION` <br> `filter t/TAG` <br> `filter m/MODULE_TAG` <br> e.g. `filter n/Alex` <br> e.g. `filter p/91031282` <br> e.g. `filter e/royb@example.com` <br> e.g. `filter d/helpful` <br> e.g. `filter t/family` <br> e.g. `filter m/CS2103` <br> |
+| **Undo**   | `undo`                                                                                                                                                                                                                                                                                                                                       |
+| **Redo**   | `redo`                                                                                                                                                                                                                                                                                                                                       |
+| **Load**   | `load` OR `load <path>`                                                                                                                                                                                                                                                                                                                      |
+| **Export** | `export INDEX`<br> e.g., `export 2`<br/>                                                                                                                                                                                                                                                                                                     |
+| **Light**  | `light`                                                                                                                                                                                                                                                                                                                                      |
+| **Dark**   | `dark`                                                                                                                                                                                                                                                                                                                                       |
+
+---

build.gradle

@@ -69,4 +69,8 @@ shadowJar {
     archiveFileName = 'addressbook.jar'
 }
 
+run {
+    enableAssertions = true
+}
+
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -1,59 +1,57 @@
 ---
 layout: page
-title: About Us
+#About Us
 ---
 
+# About us
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
 You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Joel Low
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/joellow88.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/joellow88)]
+[[portfolio](team/joellow88.md)]
 
-* Role: Project Advisor
+* Role: Developer
 
-### Jane Doe
+### Haiqel
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/acerizm.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/acerizm)]
+[[portfolio](team/acerizm.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
 
-### Johnny Doe
+### Gibson
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/gibson0918.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/Gibson0918)] [[portfolio](team/gibson0918.md)]
 
 * Role: Developer
-* Responsibilities: Data
 
-### Jean Doe
+### Toh Wei Hao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/statspadders.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/Statspadders)]
+[[portfolio](team/statspadders.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Java
 
-### James Doe
+### Elvern Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/elvern18.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/elvern18)]
+[[portfolio](team/elvern18.md)]
 
 * Role: Developer
-* Responsibilities: UI
+