Merge pull request #200 from snowstopxt/branch-xueting-readme

Update UG with introduction

docs/AboutUs.md

@@ -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, Commands

docs/DeveloperGuide.md

@@ -6,7 +6,37 @@
 
 # HireMe Developer Guide
 
-<!-- * Table of Contents -->
+<!-- TOC -->
+* [HireMe Developer Guide](#hireme-developer-guide)
+  * [**Acknowledgements**](#acknowledgements)
+  * [**Setting up, getting started**](#setting-up-getting-started)
+  * [**Design**](#design)
+    * [Architecture](#architecture)
+    * [UI component](#ui-component)
+    * [Logic component](#logic-component)
+    * [Model component](#model-component)
+    * [Storage component](#storage-component)
+    * [Common classes](#common-classes)
+  * [**Implementation**](#implementation)
+    * [Create new internship application](#create-new-internship-application)
+    * [Find internship applications](#find-internship-applications)
+    * [Filter internship applications](#filter-internship-applications)
+    * [Delete an internship application](#delete-an-internship-application)
+    * [Sort internship application list](#sort-internship-application-list)
+    * [View chart](#view-chart)
+    * [Update the Status of an Internship Application](#update-the-status-of-an-internship-application)
+  * [**Documentation, logging, testing, configuration, dev-ops**](#documentation-logging-testing-configuration-dev-ops)
+  * [**Appendix: Requirements**](#appendix-requirements)
+    * [Product scope](#product-scope)
+    * [User stories](#user-stories)
+    * [Use cases](#use-cases)
+    * [Non-Functional Requirements](#non-functional-requirements)
+* [Glossary](#glossary)
+  * [**Appendix: Instructions for manual testing**](#appendix-instructions-for-manual-testing)
+    * [Launch and shutdown](#launch-and-shutdown)
+    * [Deleting an internship application](#deleting-an-internship-application)
+    * [Saving data](#saving-data)
+<!-- TOC -->
 <page-nav-print />
 
 --------------------------------------------------------------------------------------------------------------------

docs/Testing.md

@@ -16,7 +16,7 @@
 There are two ways to run tests.
 
 * **Method 1: Using IntelliJ JUnit test runner**
-  * To run all tests, right-click on the `src/test/java` folder and choose `Run 'All Tests'`
+  * To run all tests, right-click on the `src/test/java` folder and choose `Run 'Tests in tp.test'`
   * To run a subset of tests, you can right-click on a test package,
     test class, or a test and choose `Run 'ABC'`
 * **Method 2: Using Gradle**
@@ -34,8 +34,8 @@ There are two ways to run tests.
 This project has three types of tests:
 
 1. *Unit tests* targeting the lowest level methods/classes.<br>
-   e.g. `seedu.hireme.commons.StringUtilTest`
+   e.g. `seedu.hireme.commons.util.StringUtilTest`
 1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).<br>
    e.g. `seedu.hireme.storage.StorageManagerTest`
-1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.<br>
+1. *Hybrids of unit and integration tests*. These test are checking multiple code units as well as how they are connected together.<br>
    e.g. `seedu.hireme.logic.LogicManagerTest`

docs/UserGuide.md

@@ -1,8 +1,35 @@
 # HireMe User Guide
 
-HireMe is a **desktop application for managing internship applications, optimized for use via a Command Line Interface** (CLI)
-while still having the benefits of a Graphical User Interface (GUI).
-If you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.
+HireMe is a **free desktop application that helps you manage your extensive list of internship applications.**
+
+* [Easy to use] 
+  - Type simple commands: If you can type fast, HireMe can get your internship tracking tasks done faster than traditional apps.
+* [High quality]
+  - User friendly interface: sleek list design to view all of your of internship applications.
+* [Streamlining management] 
+  - Add, delete and update your internship applications: everything you need to manage your list of internship applications.
+* [Insights]
+  - Tailored summary of your list of internship applications so that you can gain hidden insights.
+
+<!-- TOC -->
+* [HireMe User Guide](#hireme-user-guide)
+  * [Quick start](#quick-start)
+  * [Features](#features)
+    * [Viewing help : `/help`](#viewing-help--help)
+    * [Adding an internship application: `/add`](#adding-an-internship-application-add)
+    * [Listing all internship applications : `/list`](#listing-all-internship-applications--list)
+    * [Deleting an internship application : `/delete`](#deleting-an-internship-application--delete)
+    * [Finding applications by company name: `/find`](#finding-applications-by-company-name-find)
+    * [Updating the status of an internship application : `/accept`, `/pending`, `/reject`](#updating-the-status-of-an-internship-application--accept-pending-reject)
+    * [Filtering internship applications by status: `/filter`](#filtering-internship-applications-by-status-filter)
+    * [Sorting internship applications: `/sort`](#sorting-internship-applications-sort)
+    * [Clearing all entries : `/clear`](#clearing-all-entries--clear)
+    * [Viewing status chart: `/chart`](#viewing-status-chart-chart)
+    * [Exiting the program : `/exit`](#exiting-the-program--exit)
+    * [Saving the data](#saving-the-data)
+    * [Editing the data file](#editing-the-data-file)
+  * [Command summary](#command-summary)
+<!-- TOC -->
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -149,7 +176,7 @@ Examples:
 
 ### Filtering internship applications by status: `/filter`
 
-Filters all of your existing internship applications with specified status. Using /filter after /find resets the search and are not stackable.
+Filters all of your existing internship applications with specified status.
 
 Format: `/filter STATUS`
 

docs/diagrams/FilterSequenceDiagram.puml

@@ -6,8 +6,10 @@ box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":FilterCommandParser" as FilterCommandParser LOGIC_COLOR
+participant "s:StatusPredicate" as StatusPredicate LOGIC_COLOR
 participant "f:FilterCommand" as FilterCommand LOGIC_COLOR
 participant "r:CommandResult" as CommandResult LOGIC_COLOR
+
 end box
 
 box Model MODEL_COLOR_T1
@@ -30,8 +32,15 @@ deactivate FilterCommandParser
 AddressBookParser -> FilterCommandParser : parse(...)
 activate FilterCommandParser
 
+create StatusPredicate
+FilterCommandParser -> StatusPredicate
+activate StatusPredicate
+
+StatusPredicate -> FilterCommandParser
+deactivate StatusPredicate
+
 create FilterCommand
-FilterCommandParser -> FilterCommand
+FilterCommandParser -> FilterCommand : s
 activate FilterCommand
 
 FilterCommand --> FilterCommandParser : f
@@ -50,7 +59,7 @@ deactivate AddressBookParser
 LogicManager -> FilterCommand : execute(m)
 activate FilterCommand
 
-FilterCommand -> Model : updateFilteredList(f.statusPredicate)
+FilterCommand -> Model : updateFilteredList(s)
 activate Model
 
 Model --> FilterCommand

src/main/resources/view/HireMeTheme.css

@@ -138,7 +138,7 @@
     -fx-border-radius: 4px;
     -fx-background-radius: 4px;
     -fx-font-size: 13px;
-    -fx-text-fill: white;
+    -fx-text-fill: black;
     -fx-font-weight: bold;
 }
 
@@ -184,7 +184,7 @@
 
 .status-bar .label {
     -fx-font-family: "Segoe UI Light";
-    -fx-text-fill: white;
+    -fx-text-fill: black;
     -fx-padding: 4px;
     -fx-pref-height: 30px;
 }
@@ -214,27 +214,26 @@
 }
 
 .context-menu .label {
-    -fx-text-fill: white;
+    -fx-text-fill: black;
 }
 
 
 .menu-bar {
-    -fx-background-color: #F1ECE6; /* Background color for MenuBar */
+    -fx-background-color: #F1ECE6;
 }
 
 .menu-bar .menu-item {
-    -fx-text-fill: black; /* Text color for MenuItems */
+    -fx-text-fill: black;
 }
 
 .menu:hover, .menu:showing{
   -fx-background-color: derive(#F1ECE6, -10%);
 
 }
 
-/* Override the default styling to prevent bright blue */
 .menu-item:focused {
-    -fx-background-color: derive(#F1ECE6, -10%); /* Background color for focused MenuItem */
-    -fx-text-fill: black; /* Ensure text color is black when focused */
+    -fx-background-color: derive(#F1ECE6, -10%);
+    -fx-text-fill: black;
 }