[CS2113-T10-1] EasInternship

README.md

@@ -2,6 +2,22 @@
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 
+
+## Product Description
+This product aims to streamline the tracking of internship applications for the user, where the user is able to store key details of the internship as well as save and edit the status of the application. 
+
+**By using this tool, the user can:**
+
+**Store Important seedu.duke.Internship Information:** Users can input and store key details such as the role, company, duration, required skills, application deadlines, and any additional notes.
+
+**Track Application Status:** Users can save the current status of their application (e.g., not applied, applied, interview scheduled, offer received) and update it as the application progresses.
+
+**Edit and Manage Internships:** Users have the ability to edit saved internships as needed, modify statuses, update deadlines, or remove outdated internships from the list.
+
+**Filter Internships by Key Criteria:** The user can filter the tracked internships by relevant skills, application status, or upcoming deadlines, allowing for better organization and prioritization.
+
+**Monitor Deadlines Easily:** The tool helps ensure users stay on top of their internship deadlines by flagging or sorting applications with approaching deadlines.
+
 ## Setting up in Intellij
 
 Prerequisites: JDK 17 (use the exact version), update Intellij to the most recent version.
@@ -25,6 +41,18 @@ Prerequisites: JDK 17 (use the exact version), update Intellij to the most recen
    What is your name?
    ```
    Type some word and press enter to let the execution proceed to the end.
+**CS2113 T10 Team 1**
+
+**Jaden Lim Jie Chen**
+
+**Tan Ting Hui**
+
+**Jai Vinod Kumar Rahul**
+
+**Man Kit Yu****
+
+
+
 
 ## Build automation using Gradle
 

data/EasInternship.txt

@@ -0,0 +1,4 @@
+1 | ABC | XYZ | 01/01 | 01/01 | No Skills Entered | Application Pending
+2 | software engineer | abs | 01/01 | 03/24 | python | Application Completed
+3 | lawyer | lolo pte ltd | 04/23 | 01/01 | No Skills Entered | Application Pending
+4 | Technician | Nokia | 12/22 | 12/30 | No Skills Entered | Application Pending

docs/AboutUs.md

@@ -1,9 +1,8 @@
 # About us
 
-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)
+Display |   Name    |             Github Profile              | Portfolio 
+--------|:---------:|:---------------------------------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) | Jaden Lim | [Github](https://github.com/jadenlimjc) | [Portfolio](https://www.linkedin.com/in/jadenlimjc/)
+![](https://via.placeholder.com/100.png?text=Photo) | Yu Man Kit | [Github](https://github.com/Toby-Yu) | [Portfolio](toby-yu)
+![](https://via.placeholder.com/100.png?text=Photo) | Rahul | [Github](https://github.com/rahuljai-05) | [Portfolio](rahuljai-05)
+![](https://via.placeholder.com/100.png?text=Photo) | Tan Ting Hui | [Github](https://github.com/Ridiculouswifi) | [Portfolio](ridiculouswifi)

docs/UserGuide.md

@@ -1,8 +1,20 @@
 # User Guide
 
-## Introduction
+## Product Description
+This product aims to streamline the tracking of internship applications for the user, where the user is able to store key details of the internship as well as save and edit the status of the application.
+
+**By using this tool, the user can:**
+
+**Store Important seedu.duke.Internship Information:** Users can input and store key details such as the role, company, duration, required skills, application deadlines, and any additional notes.
+
+**Track Application Status:** Users can save the current status of their application (e.g., not applied, applied, interview scheduled, offer received) and update it as the application progresses.
+
+**Edit and Manage Internships:** Users have the ability to edit saved internships as needed, modify statuses, update deadlines, or remove outdated internships from the list.
+
+**Filter Internships by Key Criteria:** The user can filter the tracked internships by relevant skills, application status, or upcoming deadlines, allowing for better organization and prioritization.
+
+**Monitor Deadlines Easily:** The tool helps ensure users stay on top of their internship deadlines by flagging or sorting applications with approaching deadlines.
 
-{Give a product intro}
 
 ## Quick Start
 
@@ -11,23 +23,296 @@
 1. Ensure that you have Java 17 or above installed.
 1. Down the latest version of `Duke` from [here](http://link.to/duke).
 
-## Features 
+# Features
+
+## Add Command
+`add`
+
+Adds internship to the list of internships currently being tracked by the user. The information added is automatically saved to a .txt file. Each internship you add is assigned a unique ID for editing purposes, which is generated based on the order in which these internships were created and stored.
+
+
+This function can be expanded upon to add different features to each internship.
+
+**Format:**
+
+`add -name {Role name} -company {Company name} // default param`
+`-duration /from {start date} /to {end date} // additional params`
+
+**Example Input 1:**
+`add -name Software Engineer Intern -company Google`
+
+**Example Output 1:**
+```
+ID: 01
+Role: Software Engineer Intern
+Company: Google
+Duration: Not Stated
+Skills: Not Stated 
+```
+
+**Example Input 2:**
+`add -name Embedded Software Engineer Intern -company Continental -duration /from 05/25 /to 08/25`
+
+**Example Output 2:**
+```
+ID: 02
+Role: Embedded Software Engineer Intern
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: Not Stated
+```
+
+## Update Command
+`update`
+
+This feature allows you to update any field of an internship application. For example, when updating the status of an internship application, you can mark the status as ‘application pending’, ‘application completed’, ‘accepted’, ‘rejected’ etc.
+
+The default status for any internship that is stored in the database is ‘application pending’.
+
+**Format:**
+`update {ID} {-field} {updated information}`
+
+**Example:**
+
+`update 02 -status application completed`
+
+```
+ID: 02								 **Status**
+Role: Embedded Software Engineer Intern    		application completed
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: Not Stated
+```
+
+`Update 02 -status interview scheduled`
+
+```
+ID: 02								 Status
+Role: Embedded Software Engineer Intern    		interview scheduled
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: Not Stated
+```
+
+`Update 02 -company Venti`
+
+```
+ID: 02								 Status
+Role: Embedded Software Engineer Intern    		interview scheduled
+Company: Venti
+Duration: 05/25 to 08/25
+Skills: Not Stated
+```
+
+`Update 02 -duration /from 04/25`
+
+```
+ID: 02								 Status
+Role: Embedded Software Engineer Intern    		interview scheduled
+Company: Venti
+Duration: 04/25 to 08/25
+Skills: Not Stated
+```
+
+`update 02 -skills Python SQL`
+
+```
+ID: 02								 Status
+Role: Embedded Software Engineer Intern    		interview scheduled
+Company: Venti
+Duration: 04/25 to 08/25
+Skills: Python, SQL
+```
+## Sort Command
+`sort`
+
+This feature allows you to sort and list all the internships saved in your database. The default display format is in increasing order of their ID’s (based on time of creation)
+
+Users can specify a flag to display them in alphabetical order (regardless of uppercase or lowercase) of their role titles or by deadline.
+
+**Format:**
+
+
+`sort {field}`
+
+**Example:**
+
+`sort -deadline`
+
+```
+ID: 02
+Role: Software Engineer Intern
+Company: Google
+Duration: 05/23 to 08/25
+Skills: Not Stated
+
+ID: 01
+Role: Embedded Software Engineer Intern
+Company: Continental
+Duration: 05/24 to 08/24
+Skills: Not Stated
+```
+`sort -alphabet`
+
+```
+ID: 02
+Role: Embedded Software Engineer Intern
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: Not Stated
+
+ID: 01
+Role: Software Engineer Intern
+Company: Google
+Duration: Not Stated
+Skills: Not Stated
+```
+## Filter command: 
+`filter`
+
+This feature is an extension of the previous list feature. It allows the user to specify certain values for any of the role name, company name or duration parameters based on which only the relevant internships are shown. 
+
+The role and company name parameters are case-insensitive, For the duration parameter, this feature displays all relevant internships whose start dates and end dates are within the duration timeline specified by the user.  For the MVP version of the product, user can only sort by 1 field at a time.
+
+**Format:**
+
+`filter -role {Role name} -`
+
+`filter -company {Company name}`
+
+`filter -duration /from {start date} /to {end date}`
+
+`filter -skills {skill}`
+
+`filter -deadline /by {date}`
+
+**Example:**
+
+`list`
+
+```
+ID: 01
+Role: Software Engineer Intern
+Company: Google
+Duration: Not Stated
+Skills: Not Stated
+
+ID: 02
+Role: Embedded Software Engineer Intern
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: Not Stated
+```
+`filter -company Google`
+
+```
+ID: 01
+Role: Software Engineer Intern
+Company: Google
+Duration: Not Stated
+Skills: Not Stated
+```
+
+`filter -duration /from 04/25 /to 09/25`
+
+```
+ID: 02
+Role: Embedded Software Engineer Intern
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: Not Stated
+```
+
+## Delete Command: 
+`del`
+
+This feature removes an entire listing from the tracker.
+
+**Format:** `del {ID}`
+
+**Example:**
+
+`list`
+
+```
+ID: 01
+Role: Embedded Software Engineer Intern
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: Not Stated
+
+ID: 02
+Role: Software Engineer Intern
+Company: Google
+Duration: Not Stated
+Skills: Not Stated
+```
+
+`del {01}`
+
+```
+You have deleted this listing:
+
+ID: 01
+Role: Embedded Software Engineer Intern
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: Not Stated
+```
+
+`list`
+
+```
+ID: 02
+Role: Software Engineer Intern
+Company: Google
+Duration: Not Stated
+Skills: Not Stated
+```
+
+## Help Command: 
+`help`
+
+Shows the commands available for the user.
+Describes the available functions and inputs that are needed
+Other basic commands.
+
+**Format:** `/help`
+
+**Example Output**
+
+```
+    add -name {Role name} -company {Company name}: Adds internship to the list of internships currently being tracked by the user.
+
+
+    update {ID} {-field} {updated information}: Adds information to the field of the entry tagged to the ID.
+    Eg. update 02 -status application completed
+```
+
+
+## Exit Command
+
+Terminates the program.
+
+**Format:** `/exit`
+
+
+
+## Invalid Inputs
+Shows whenever an incomplete or invalid search call is performed. Output also shows what corrective action can be taken.
+
+Example Output:
+Please include a duration if you are using the -duration flag!
+Eg. Update 02 -duration /from 04/25
 
-{Give detailed description of each feature}
+Please include specific skills if you are using the -skills flag!
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+I do not understand what flag you are using, type /help to get a list of valid commands.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
 
-Example of usage: 
 
-`todo n/Write the rest of the User Guide d/next week`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
 
 ## FAQ