nus-cs2113-AY2122S2 · edemirkirkan · Mar 4, 2022 · Mar 4, 2022 · Mar 4, 2022 · Mar 4, 2022
diff --git a/.gitignore b/.gitignore
@@ -8,10 +8,15 @@
 /build/
 src/main/resources/docs/
 
+*.jar
+
 # MacOS custom attributes files created by Finder
 .DS_Store
 *.iml
 bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+
+.vscode/
+data.txt
diff --git a/META-INF/MANIFEST.MF b/META-INF/MANIFEST.MF
@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.TARBS
+
diff --git a/build.gradle b/build.gradle
@@ -12,6 +12,9 @@ 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'
+    testImplementation('org.junit.platform:junit-platform-launcher:1.5.2')
+    // testImplementation(platform('org.junit:junit-bom:5.8.2'))
+	// testImplementation('org.junit.jupiter:junit-jupiter')
 }
 
 test {
@@ -43,4 +46,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
diff --git a/data.txt b/data.txt
@@ -0,0 +1,4 @@
+Experience Seoul | 1 | 01/04/2022 | 08/04/2022 | Marriott Seoul | 100.11 | Korea | 20 | 19$
+Conquer Summits | 2 | 05/05/2022 | 11/05/2022 | Hotel Schweizerhof Luzern | 80.0 | Switzerland | 20 | 6$2,Tim,98765432,3%2,Brendan,12345,3%
+Back To Our Roots | 3 | 01/04/2022 | 20/04/2022 | Hotel in Malaysia | 50.0 | Malaysia | 100 | 6$3,Tim,98765432,3%3,Brendan,12345,3%
+ski | 6 | 29/02/2020 | 19/02/2022 | hotel | 80.0 | country | 30 | 0$
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -1,9 +1,9 @@
 # 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) | Ege Demirkirkan | [Github](https://github.com/edemirkirkan) | [Portfolio](team/edemirkirkan.md) |
+| ![](https://via.placeholder.com/100.png?text=Photo) |   Justyn Phoa   | [Github](https://github.com/mafpovbul)    | [Portfolio](team/mafpovbul.md)    |
+| ![](https://via.placeholder.com/100.png?text=Photo) |  Timothy Chang  | [Github](https://github.com/timchang27)   | [Portfolio](team/timchang27.md)   |
+| ![](https://via.placeholder.com/100.png?text=Photo) |   Brendan Ang   | [Github](https://github.com/bbawj)        | [Portfolio](team/bbawj.md)        |  
+| ![](https://via.placeholder.com/100.png?text=Photo) |  Chin Tai Ann   | [Github](https://github.com/chintaiann)   | [Portfolio](team/chintaiann.md)   |
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -1,38 +1,131 @@
+# Travel Agency Reservation Booking System (TARBS)
 # Developer Guide
 
-## Acknowledgements
+## Setting Up
 
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+First, fork this repo, and clone the fork into your computer.
 
-## Design & implementation
+You are recommended to use Intellij IDEA to edit the program.
+
+1. Configure the JDK: Ensure Intellij is configured to use JDK 8 or higher.
+2. Import the project as a Gradle project: Choose the option to import the project as a Gradle project when prompted.
+3. Verify the setup: Enter some commands to ensure TARBS functions as expected.
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+## Design & implementation
+### Basic Class Diagram 
+![image](https://user-images.githubusercontent.com/53790951/160271319-4a351f51-afd7-4e04-9451-f04143146551.png)
 
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+- Studies in a non-IT field
+- Usually works alone
+- Working in a small travel agency that offers affordable budget travel packages to only some countries
+- Handles many customers a day
+- Is unfamiliar with using CLI apps
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+- Travel agencies often have to manage multiple customers and their respective bookings or plans.
+- For employees of the travel agencies to track and record customers’ booking of travel packages. 
+
 
 ## User Stories
 
 |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|
+|v1.0|new user|Add reservation for a customer with basic information such as name, country etc. |Make a reservation|
+|v1.0|new user|Print a list of all current and available travel packages |View all current travel packages and tell customers about our travel packages with one look|
+|v1.0|new user|Remove an existing reservation|Remove information that we do not need anymore|
+|v1.0|new user|Search for a specific travel package|Make recommendations to a customer based on their desired travel package requirements|
+|v2.0|User ready to start using the app|Upload existing reservation data|Get started quickly|
+|v2.0|User ready to start using the app|Make reservations based on custom input and edit them where necessary|Get familiar with inputting|
+|v2.1|Expert user|Ascertain the error in my input based on the error messages from the application|Quickly troubleshoot any mistakes that would slow down my work|
+|v2.1|Expert user|View all reservations currently under a specific travel package|Optimize that travel package according to user’s feedback|
+|v2.1|Expert user|Sort all packages according to date, price or vacancies|Give better recommendations to customers|
+
 
 ## Non-Functional Requirements
 
-{Give non-functional requirements}
+### Performance Requirements
+- Should work on any mainstream OS as long as it has Java 11 or above installed.
+
+### Usability
+- A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
+- Prompts and instructions must be in proper and concise sentences for ease of understanding.
 
 ## Glossary
 
 * *glossary item* - Definition
+* Packages - Travel Package within the agency's database
+* Reservations - Reservation of travel package made by one customer through the app 
+
+
+### Summary of User Commands
+
+| Command | Format Examples                                                                                                                                                                               |
+| ------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|help| help <br/> (prints details of all commands)                                                                                                                                                   |
+|packages| packages <br/> (prints details of all packages)                                                                                                                                               |
+|info| info {num} (num <= number of available packages) <br/> e.g. info 2                                                                                                                            |
+|all| all <br/> Will prompt user to enter 1,2,3 to print out packages sorted by date, price or vacancies. 4 to return.                                                                              |
+|add| add {package_name},{ID},{startDate},{endDate},{hotel},{price},{country},{vacancies} <br/>  e.g. add Skiing Trip,1,23/2/2022,24/2/2022,hotelName,90.99,Singapore,20 <br/> adds a TravelPackage |
+|delete| delete {num} (num <= number of available packages) <br/> e.g. delete 2 <br/> delete a TravelPackage                                                                                           |
+|reserve| reserve {package_number},{contact_name},{contact_number},{number_pax} <br/> e.g reserve 3,John,91234567,3                                                                                     |
+|remove| remove {package_number},{contact_number} <br/> e.g remove 1,8888888 <br/> remove an existing reservation                                                                                      |
+|reservations| reservations {package_number} <br/> eg. reservations 2 <br/> print all reservations for a given travelPackageID                                                                               |
+|addHotel| addHotel {hotel_id},{hotel_name},{country},{price},{package_number} <br/> eg. addHotel 1,Hotel99,Singapore,100,1 <br/> Add a Hotel to the Itinerary                                           |
+|hotels| hotels {package_number} <br/> eg. hotels 1 <br/> View all hotels offering this package                                                                                                        |
+
+### Test Case 1
+
+New employees can enter `packages` to view all available packages by the agency.
+
+Additionally, they can enter `info {package number}` to view more in-depth information about the package.
+
+![image](https://user-images.githubusercontent.com/64303732/161110520-8ed18ddc-b356-43d5-95ed-7df5ca2de91d.png)
+
+Employees can also input new reservations using `reserve {package_number},{contact_name},{contact_number},{number_pax}`
+
+They can then view and verify reservations for that package using `reservation {package_number}`
+
+![image](https://user-images.githubusercontent.com/64303732/161111482-a2f9600d-d1f0-45b1-9a51-ef28848e4b57.png)
+
+![image](https://user-images.githubusercontent.com/64303732/161111551-c1acfd1e-90f3-426e-b8e3-175f050dba42.png)
+
+
+## Feature - Help Command 
+Aim: Displays a list of all available commands that the user can refer to as a guide
+
+![image](HelpCommand.png)
+
+
+
+## Feature - Storage
+#### Initialisation (Loading Data)
+The sequence diagram that shows how `Storage` is created and the data is loaded from the saved files when the program is initialised is shown below:
+![](LoadFileSeqDiag.png)
+
+1. `TARBS` creates a Storage object with the relevant file name (`filePath`).
+2. `TARBS` then calls the `createPackages()` method of the Storage class
+3. `storage` will call the `parseSavedFile()` method, which initiates a while loop that iterates through the text file and processes the string data using the respective `parse` methods.
+4. A new `TravelPackage` object is constructed with the relevant data.
+5. A new `Packages` object is created using the `TravelPackage` object and returned back to `TARBS`.
+
+#### Saving data
+The sequence diagram that shows how `Storage` is used to save the current list of travel packages and reservations is shown below: </br>
+
+![](SaveFilesSeqDiag.png)
+
+1. `TARBS` calls the `savePackageToFile()` method of `storage`, passing in the `packages` object.
+2. `storage` will then use a loop to iteratively retrieve the data in string format from the individual `TravelPackage` objects.
+3. `storage` will create a new `FileWriter` object to write the string data into a text file.
+
+## Feature - Parser
+The sequence diagram shows an example of how a user input is parsed and returns a new `Command`.
+
+For simplicity, `ByeCommand` is shown here:
 
-## Instructions for manual testing
+![image](https://user-images.githubusercontent.com/53790951/160289728-5a17b2ea-0599-48f4-a18b-cadfbbcbfb11.png)
 
-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
diff --git a/docs/HelpCommand.png b/docs/HelpCommand.png
diff --git a/docs/LoadFileSeqDiag.png b/docs/LoadFileSeqDiag.png
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,9 @@
-# Duke
+# Travel Agency Reservation Booking System - TARBS
+- TARBS is a CLI application made using Java 11 to help staff of a Travel Agency company keep track of its' travel packages, as well as customer's reservations. 
+- Some features include creating and storing travel packages, viewing of said packages and the ability to record reservations made by customers using their mobile numbers.
+- It is also user-friendly as it includes the ability to delete any entries that were keyed in wrongly - be it packages or reservations. 
 
-{Give product intro here}
+- Do refer to the links below for more information on the application!
 
 Useful links:
 * [User Guide](UserGuide.md)

diff --git a/docs/SaveFilesSeqDiag.png b/docs/SaveFilesSeqDiag.png
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -2,41 +2,139 @@
 
 ## Introduction
 
-{Give a product intro}
+Travel Agency Reservation Booking System (TARBS) is a desktop app for managing reservations for travel packages and tourist attractions, optimised for use via a Command Line Interface (CLI). If you can type fast, TARBS can help to improve efficiency of adding and editing reservations, amongst many other features.
 
-## Quick Start
 
-{Give steps to get started quickly}
+### Why do we need TARBS?
+Travel agencies often have to manage multiple customers and their respective bookings or plans.
+
+## Quick Start
 
 1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+1. Down the latest version of `TARBS` from [here](https://github.com/AY2122S2-CS2113-F10-3/tp/releases).
 
 ## Features 
 
-{Give detailed description of each feature}
+### Quick Help: `help`
+Print detailed instructions on the available commands that users may input.
+
+Usage: `help`
+
+### Show all packages: `packages`
+
+View a list of all available packages
+
+Usage: `packages`
+
+### Viewing a package: `info`
+View a specified Travel Package from the list of Packages based on the package ID.
+
+Format: `info {package_number}`
+
+Example of usage:
+
+`info 2`
+
+### Show packages sorted by starting date, price or vacancies : `all` 
+View list of packages sorted by ascending date or price and descending vacancies. 
+
+Format: `all` 
+
+Example of usage:
+```
+all
+
+Sort packages by:
+1. Date (Earliest to Latest) 
+2. Number of vacancies left
+3. Price
+4. Return to main menu.
+
+Enter 1-4
+```
+
+
+
+
+### Adding a package: `add`
+Adds a new Travel Package to the list of Packages.
+
+Format: `add {package_name},{package_number},{startDate},{endDate},{hotel},{price},{country},{vacancies}`
+
+* The `startDate` and `endDate` must be in the format DD/MM/YYYY.
+* The `price` can only contain numbers or decimal points.
+* `package_number` should be unique. 
+
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+Example of usage: 
+
+`add Skiing Trip,1,23/02/2022,24/02/2022,hotelName,90.99,Singapore,20`
+
+
+### Deleting a package: `delete`
+Delete a Travel Package from the list of Packages based on the package ID.
+
+Format: `delete {package_number}`
+
+Example of usage: 
+
+`delete 2`
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+### Placing a reservation: `reserve`
+Add a reservation to a Travel Package.
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+Format: `reserve {package_number},{contact_name},{contact_number},{number_pax}`
 
 Example of usage: 
 
-`todo n/Write the rest of the User Guide d/next week`
+`reserve 3,John,91234567,3`
+
+### Removing a reservation: `remove`
+Remove a reservation from a Travel Package using packageID and contact number. 
+
+Format: `remove {package_number},{contact_number}`
+
+Example of usage: 
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+`remove 1,8888888`
+
+### View reservations: `reservations`
+View reservations booked in a Travel Package.
+
+Format: `reservations {package_number}`
+
+Example of usage: 
+
+`reservations 2`
+
+### Exit application:
+Format and Usage:
+```
+bye
+```
 
 ## FAQ
 
 **Q**: How do I transfer my data to another computer? 
 
-**A**: {your answer here}
+**A**: When starting the application, data.txt will be created if there isn't one already. Simply place the data.txt with the executable JAR file on the new computer and you are good to go. 
+
+
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+| Command | Syntax                                                                                          |
+| --- |:------------------------------------------------------------------------------------------------|
+| help | help                                                                                            |
+| packages | packages                                                                                        |
+| info | info {package_number}                                                                               |
+| all | all                                                                                             | 
+| add | add {package_name},{package_number},{startDate},{endDate},{hotel},{price},{country},{max_vacancies} |
+| delete | delete {package_number}                                                                             |
+| reserve  | reserve {package_number},{contact_name},{contact_number},{number_pax}                               |
+| remove | remove {package_number},{contact_number}                                                            |
+| reservations | reservations {package_number}                                                                       |
+
+
+
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1 @@
+theme: jekyll-theme-minimal