CI Status codecov

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

Main UI

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

:information_source: Notes about the command format:

  • Words in UPPER_CASE are the parameters to be supplied by the user.
    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.
    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.
    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.
    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.
    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.
    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.

Guides

User Guide

Developer Guide

FAQ

Q: How do I transfer my data to another Computer?
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]…​
e.g., add n/Benedict Tan d/Great Friend e/BenedictTan@gmail.com p/98070707 t/Friend m/CS2103 m/CS3230 		 
View view INDEX
e.g., view 2 		 
Clear clear  
Delete delete INDEX or delete INDEXES or delete NAME
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]…​
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
filter p/PHONE_NUMBER
filter e/EMAIL_ADDRESS
filter d/DESCRIPTION
filter t/TAG
filter m/MODULE_TAG
e.g. filter n/Alex
e.g. filter p/91031282
e.g. filter e/royb@example.com
e.g. filter d/helpful
e.g. filter t/family
e.g. filter m/CS2103
 
Undo undo  
Redo redo  
Load load OR load <path>  
Export export INDEX
e.g., export 2
  
Light light  
Dark dark  

Acknowledgements