{{ page.alt_title | escape }}
-
- {{ content }}
-
-
-
- {{ content }}
-
- 
+### Darren Teo
+
+
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/darhh)]
+[[portfolio](team/darhh.md)]
-* Role: Project Advisor
+* Role: Integration, Documentation
+* Responsibilities: In charge of versioning of the code, maintaining the code repository, integrating various parts of the software to create a whole. Responsible for the quality of various project documents.
-### Jane Doe
+### Goh Lucas
-
+
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/gohlucas)]
+[[portfolio](team/gohlucas)]
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Scheduling and Tracking, Documentation
+* Responsibilities: In charge of defining, assigning, and tracking project tasks. Responsible for the quality of various project documents.
-### Johnny Doe
+### Noah Ang
-
+
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/noahang)]
+[[portfolio](team/noahang)]
* Role: Developer
-* Responsibilities: Data
+* Responsibilities: Code Quality
-### Jean Doe
+### Somneel
-
+
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/SomneelSaha2004)]
+[[portfolio](team/somneelsaha2004)]
* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Deliverables and Deadlines
-### James Doe
+### Isaac Chua
-
+
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/isaacchua0309)]
+[[portfolio](team/isaacchua0309.md)]
* Role: Developer
-* Responsibilities: UI
+* Responsibilities: Testing
+
+
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
index 743c65a49d2..54dd58cdfe2 100644
--- a/docs/DeveloperGuide.md
+++ b/docs/DeveloperGuide.md
@@ -1,16 +1,60 @@
---
layout: page
-title: Developer Guide
+title: FitFriends Developer Guide
---
-* Table of Contents
-{:toc}
+# FitFriends Developer Guide
+## Table of Contents
+
+
+- [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)
+ - [Game Creation feature](#game-creation-feature)
+ - [Game Deletion feature](#game-deletion-feature)
+ - [Global Sports List Management feature](#global-sports-list-management-feature)
+- [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)
+ - [Adding a person](#adding-a-person)
+ - [Editing a person](#editing-a-person)
+ - [Deleting a person](#deleting-a-person)
+ - [Creating a sport in the global list](#creating-a-sport-in-the-global-list)
+ - [Listing global sports](#listing-global-sports)
+ - [Deleting a sport from global list](#deleting-a-sport-from-global-list)
+ - [Adding a sport to a person](#adding-a-sport-to-a-person)
+ - [Deleting a sport from a person](#deleting-a-sport-from-a-person)
+ - [Finding persons who play specific sports](#finding-persons-who-play-specific-sports)
+ - [Finding persons who play a particular sport near a location](#finding-persons-who-play-a-particular-sport-near-a-location)
+ - [Adding a game](#adding-a-game)
+ - [Deleting a game](#deleting-a-game)
+ - [Adding a member to a game](#adding-a-member-to-a-game)
+ - [Deleting a member from a game](#deleting-a-member-from-game)
--------------------------------------------------------------------------------------------------------------------
## **Acknowledgements**
-* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
-
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+* Some features such as addGame, deleteGame were reused from AddressBook-Level3.
+* Code Reuse Declaration: `postal_code_data.json` found in resources/locationdata was taken from the following[ public repository](https://github.com/xkjyeah/singapore-postal-codes). The data provided has been used for validation and distance calculation for sorting across the app. However, all code required to use it in our app has been written by the team, with the help of AI tools.
+* AI Declaration: This project has been developed with the assistance of artificial intelligence (AI) tools, which were used regularly throughout the development process. These AI tools assisted in generating ideas, reviewing and completing code, and improving documentation. All AI-generated content was carefully reviewed and refined by the project team to ensure quality, accuracy, and consistency with our project objectives. The integration of AI technologies helped streamline our workflows and foster innovation while maintaining full human oversight and decision-making in the final outputs.
+> ⚠️ **AI tools and Usages**:
+> * ChatGPT: Darren, Lucas and Somneel
+> * Cursor: Isaac
+> * GitHub Copilot: Noah
--------------------------------------------------------------------------------------------------------------------
## **Setting up, getting started**
@@ -70,7 +114,7 @@ The sections below give more details of each component.
The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
-
+
The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.
@@ -117,14 +161,14 @@ How the parsing works:
### Model component
**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java)
-
+
The `Model` component,
* stores the address book data i.e., all `Person` objects (which are contained in a `UniquePersonList` object).
* stores the currently 'selected' `Person` objects (e.g., results of a search query) as a separate _filtered_ list which is exposed to outsiders as an unmodifiable `ObservableList:information_source: **Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.
@@ -138,7 +182,7 @@ The `Model` component, **API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java) -
+
The `Storage` component,
* can save both address book data and user preference data in JSON format, and read them back into corresponding objects.
@@ -155,93 +199,82 @@ Classes used by multiple components are in the `seedu.address.commons` package.
This section describes some noteworthy details on how certain features are implemented.
-### \[Proposed\] Undo/redo feature
-
-#### Proposed Implementation
-
-The proposed undo/redo mechanism is facilitated by `VersionedAddressBook`. It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`. Additionally, it implements the following operations:
-
-* `VersionedAddressBook#commit()` — Saves the current address book state in its history.
-* `VersionedAddressBook#undo()` — Restores the previous address book state from its history.
-* `VersionedAddressBook#redo()` — Restores a previously undone address book state from its history.
-
-These operations are exposed in the `Model` interface as `Model#commitAddressBook()`, `Model#undoAddressBook()` and `Model#redoAddressBook()` respectively.
-
-Given below is an example usage scenario and how the undo/redo mechanism behaves at each step.
-
-Step 1. The user launches the application for the first time. The `VersionedAddressBook` will be initialized with the initial address book state, and the `currentStatePointer` pointing to that single address book state.
-
-
-
-Step 2. The user executes `delete 5` command to delete the 5th person in the address book. The `delete` command calls `Model#commitAddressBook()`, causing the modified state of the address book after the `delete 5` command executes to be saved in the `addressBookStateList`, and the `currentStatePointer` is shifted to the newly inserted address book state.
+### Game Creation feature
+The `addgame` command creates and adds a new `Game` object into the addressbook. Each `Game` object has 4 attributes: `Sport`, `LocalDateTime`, `Location` and `UniquePersonList` which are specified using the prefixes g/, dt/, pc respectively with their corresponding values. As a `Game` object is initialised without any participants at first, the `UniquePersonList` field is not mutable during initialisation and thus not included in the command.
-
+#### Implementation
+The `Game` object is added into a `UniqueGameList` object whenever `addgame` command is called. This mirrors the `Person` object and `UniquePersonList` object interaction very closely. These are shown on the User Interface via fxml code. Subsequently, the writing to and reading from the addressbook.json which stores the data is facilitated using JsonAdaptedGame and JsonAdaptedPerson which helps to convert the information to and from json readable format.
-Step 3. The user executes `add n/David …` to add a new person. The `add` command also calls `Model#commitAddressBook()`, causing another modified address book state to be saved into the `addressBookStateList`.
+### Game Deletion feature
+Similar to `addgame` feature
-
+### Global Sports List Management feature
-
-The `redo` command does the opposite — it calls `Model#redoAddressBook()`, which shifts the `currentStatePointer` once to the right, pointing to the previously undone state, and restores the address book to that state.
+
-
+* **Alternative 1 (current choice):** Use a static set in the Sport class.
+ * Pros: Easy to access from anywhere in the codebase, consistent validation.
+ * Cons: Static state can be more difficult to test.
-#### Design considerations:
+* **Alternative 2:** Store in Model as a field.
+ * Pros: Follows the architectural pattern more closely, easier to test.
+ * Cons: Requires passing the model to more components, potentially complicating the design.
-**Aspect: How undo & redo executes:**
+**Aspect: Command structure for deleting sports**
-* **Alternative 1 (current choice):** Saves the entire address book.
- * Pros: Easy to implement.
- * Cons: May have performance issues in terms of memory usage.
+* **Alternative 1 (current choice):** Have two separate usages for `deletesport` command (with and without sport name).
+ * Pros: Intuitive naming, as both commands deal with deleting sports.
+ * Cons: Could cause confusion due to the dual behavior.
-* **Alternative 2:** Individual command knows how to undo/redo by
- itself.
- * Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
- * Cons: We must ensure that the implementation of each individual command are correct.
+* **Alternative 2:** Use separate commands like `deleteglobalsport` and `deletepersonsport`.
+ * Pros: Clear distinction between different operations.
+ * Cons: More commands to learn, potentially less intuitive naming.
-_{more aspects and alternatives to be added}_
+#### Future enhancements:
-### \[Proposed\] Data archiving
-
-_{Explain here how the data archiving feature will be implemented}_
+* **Categorization**: Group sports by type (e.g., team sports, individual sports).
+* **Popularity tracking**: Track which sports are most commonly used across contacts.
+* **Sport details**: Add additional information like required equipment or typical venue types.
--------------------------------------------------------------------------------------------------------------------
@@ -263,34 +296,51 @@ _{Explain here how the data archiving feature will be implemented}_
**Target user profile**:
* has a need to manage a significant number of contacts
+* has a need for frequent sporting activities with friends
* prefer desktop apps over other types
* can type fast
* prefers typing to mouse interactions
* is reasonably comfortable using CLI apps
**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
+so as to reduce the hassle when organizing sports meetups.
### User stories
Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
-| Priority | As a … | I want to … | So that I can… |
-| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- |
-| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App |
-| `* * *` | user | add a new person | |
-| `* * *` | user | delete a person | remove entries that I no longer need |
-| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list |
-| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident |
-| `*` | user with many persons in the address book | sort persons by name | locate a person easily |
-
-*{More to be added}*
+| Priority | As a … | I want to … | So that I can… |
+|----------|---------------------------------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
+| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App |
+| `* * *` | user | add a new person | so that I can store their information |
+| `* * *` | user | delete a person | remove entries that I no longer need |
+| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list |
+| `* * *` | sporty person | add a person's preferred sport | know who to arrange games with when I want to play a certain sport |
+| `* * *` | sporty person | add a friend's contact number | contact them to meet up for games in future |
+| `* * *` | user looking to pick up a new sport | find friends by sport played | invite them to play or teach me the sport |
+| `* * *` | network enthusiast | see where my contacts live | meet up with them more easily |
+| `* * *` | impromptu person | see where my friends live | see which friends are in the area when I am out and suddenly want to catch up |
+| `* * *` | caring friend | see what sports my friends play | arrange a session when I have something to talk about/check on them |
+| `* *` | sporty person | find sports facilities near me | play sports there |
+| `* *` | user | hide private contact details | protect the contact details of persons in my address book |
+| `* *` | student | receive suggested sports venues based on my group's location | arrange a meetup location which is fair and convenient |
+| `* *` | user who prefers structured planning | book facilities directly through the app | reduce the hassle of navigating multiple booking applications |
+| `* *` | busy professional | quickly check for the nearest sports facility before heading down | save time |
+| `* *` | user who dislikes long commutes | set a maximum travel distance to be used to filter out addresses that are too far away from my location | receive suggestions from the application which fall within my preferred range |
+| `* *` | user | be able to edit an existing contact | update their contact details |
+| `* *` | working professional | add my favourite sports venues | quickly suggest them for meetups |
+| `* *` | thrifty user | be able to filter results only to show free to use facilities | enjoy sports without paying for private courts |
+| `* *` | tennis player | be reminded to bring my racket | save the trouble of having to borrow a racket at the last minute |
+| `* *` | sporty person | set my friend's preferred play locations | know where to meet them for games |
+| `* *` | working adult | tag contacts with custom labels | categorize them by friends/work |
+| `* *` | sports coach | track where my students live | organize training sessions at convenient locations |
### Use cases
(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise)
-**Use case: Delete a person**
+**Use case 1: Delete a person**
**MSS**
@@ -298,35 +348,100 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
2. AddressBook shows a list of persons
3. User requests to delete a specific person in the list
4. AddressBook deletes the person
+ Use case ends.
+ **Extensions**
+* 2a. The list is empty.
+ Use case ends.
+* 3a. The given index is invalid.
+ * 3a1. AddressBook shows an error message.
+
+ Use case resumes at step 2.
+
+**Use case 2: Tag a contact**
+
+**MSS**
+
+1. User requests to list persons
+2. AddressBook shows a list of persons
+3. User requests to tag a specific person in the list
+4. AddressBook updates the person's contact details
Use case ends.
-**Extensions**
+ **Extensions**
* 2a. The list is empty.
Use case ends.
-* 3a. The given index is invalid.
+* 3a. The person is not in the list.
+
+ * 3a1. AddressBook shows an error message.
+
+ Use case resumes at step 2.
+
+**Use case 3: Filter by location**
- * 3a1. AddressBook shows an error message.
+**MSS**
+
+1. User requests to list persons
+2. AddressBook shows a list of persons
+3. User enters a location to filter the list
+4. AddressBook updates the list shown to user
+
+ Use case ends.
+
+ **Extensions**
+
+* 2a. The list is empty.
- Use case resumes at step 2.
+ Use case ends.
+
+* 3a. The given location is invalid.
+
+ * 3a1. AddressBook shows an error message.
+
+ Use case resumes at step 2.
+
+* 4a. The given location does not belong to any user.
-*{More to be added}*
+ * 4a1. AddressBook shows an error message.
+
+ Use case resumes at step 2.
+
+**Use case 4: Edit a contact**
+
+**MSS**
+
+1. User searches for a person
+2. AddressBook shows matching result(s)
+3. User requests to view contact details
+4. AddressBook shows contact details
+5. User selects field to update details
+6. AddressBook reflects updated contact details
+
+ Use case ends.
+
+ **Extensions**
+
+* 2a. The list is empty.
+
+ Use case ends.
### Non-Functional Requirements
1. Should work on any _mainstream OS_ as long as it has Java `17` or above installed.
2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
3. 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.
-
-*{More to be added}*
+4. The system must be designed for a single user only, user data is private and not shared between different users.
+5. Users should be able to run the application from a single executable JAR file.
+6. The system must automatically save data after each user edit to ensure data persistence.
### Glossary
* **Mainstream OS**: Windows, Linux, Unix, MacOS
* **Private contact detail**: A contact detail that is not meant to be shared with others
+* **JAR File**: A compressed package that bundles Java classes, resources metadata into a single executable file
--------------------------------------------------------------------------------------------------------------------
@@ -334,49 +449,242 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
Given below are instructions to test the app manually.
-
+ Expected: The most recent window size and location is retained. However, if the window was closed in light mode, it will start in dark mode as we chose to reduce the glare when the application is booted up. + +### Adding a person + +#### Adding a person to contact list - 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. +1. Prerequisites: None. -1. Saving window preferences +2. Test case: `add n/John Doe p/98765432 e/johnd@example.com a/John Street, #01-01 t/bestfriend s/tennis pc/402001`
+ Expected: John Doe contact is added to the list. Details of the contact shown in the status message. PersonCard is found in the list on the left. - 1. Resize the window to an optimum size. Move the window to a different location. Close the window. +3. Test case: `add n/John Doe p/98765432 e/johnd@example.com a/John Street, #01-01 t/bestfriend s/tennis pc/123456`
+ Expected: No person is added due to invalid postal code. Error details shown in the status message. - 1. Re-launch the app by double-clicking the jar file.
- Expected: The most recent window size and location is retained. +4. Other incorrect add commands to try:
+ `add n/John Doe p/ e/johnd@example.com a/John Street, #01-01 s/tennis pc/402001`,
+ `add n/John Doe p/98765432 e/johnd@example.com a/, #01-01 s/tennis pc/402001`, `...`
+ Expected: Similar to previous. -1. _{ more test cases … }_ +### Editing a person + +#### Editing a person while at least one person is being shown + +1. Prerequisites: List all persons using the `list` command or List persons using the 'find' command. At least 1 person in the list. + +2. Test case: `edit 1 n/Alicia Tay`
+ Expected: First contact has name edited to \"Alicia Tay\". Details of the outcome of the edit shown in the status message. + +3. Test case: `edit 1 n/`
+ Expected: No name is edited due to erroneous name field. Details of the error shown in the status message. + +4. Other incorrect edit commands to try: `edit`, `edit x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. ### Deleting a person -1. Deleting a person while all persons are being shown +#### Deleting a person while all persons are being shown + +1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. + +2. Test case: `delete 1`
+ Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + +3. Test case: `delete 0`
+ Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. + +4. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Creating a sport in the global list + +#### Creating a sport + +1. Prerequisites: None. + +2. Test case: `createsport s/archery`
+ Expected: Archery will be created in the global list. Details of the outcome of the createsport shown in the status message. + +3. Other incorrect createsport commands to try: `createsport`, `...`
+ Expected: Similar to previous. + +### Listing global sports + +#### Lists all global sports. + +1. Prerequisites: None + +2. Test case: `listsports`
+ Expected: Lists all registered sports in the status message. + +3. Other incorrect listsports commands to try: `listsports 1`, `deletesport abc`, `...`
+ Expected: Similar to previous. + +### Deleting a sport from global list + +#### Deleting a sport from list of registered sports + +1. Prerequisites: At least 1 sport in the global list. + +2. Test case: `deletesport 1`
+ Expected: The first sport in the list, if it exists, is deleted. Details of the outcome of the deletesport shown in the status message. + +3. Test case: `deletesport 0`
+ Expected: No sport is deleted due to invalid index. Details of the outcome of the deletesport shown in the status message. + +4. Other incorrect deletesport commands to try: `deletesport`, `deletesport x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Adding a sport to a person + +#### Adding a sport to a person while at least one person is being shown + +1. Prerequisites: List all persons using the `list` command or List persons using the 'find' command. At least 1 person in the list. + +2. Test case: `addsport 1 s/basketball`
+ Expected: First contact has basketball added to its registered sports, unless the sport already exists in their contact. Details of the outcome of the addsport shown in the status message. + +3. Test case: `addsport 1 s/chocolate`
+ Expected: No sport is added due to invalid sport. Details of the outcome of the addsport shown in the status message. + +4. Test case: `addsport 0 s/basketball`
+ Expected: No sport is added due to invalid index. Details of the outcome of the addsport shown in the status message. + +5. Other incorrect addsport commands to try: `addsport`, `addsport x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + + +### Deleting a sport from a person + +#### Deleting a sport from a person while at least one person is being shown + +1. Prerequisites: List all persons using the `list` command or List persons using the 'find' command. At least 1 person in the list. + +2. Test case: `deletesport 1 s/basketball`
+ Expected: First contact has basketball deleted from its registered sports, if the sport already exists in their contact. Details of the outcome of the deletesport shown in the status message. + +3. Test case: `deletesport 1 s/chocolate`
+ Expected: No sport is deleted due to invalid sport. Details of the outcome of the deletesport shown in the status message. + +4. Test case: `deletesport 0 s/basketball`
+ Expected: No sport is added due to invalid index. Details of the outcome of the deletesport shown in the status message. + +6. Other incorrect deletesport commands to try: `deletesport`, `deletesport x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Finding persons who play specific sports + +#### Displaying a list of person who play specific sports + +1. Prerequisites: At least one person must play one of the sports in the list of sports provided. + +2. Test case: `findsport s/basketball`
+ Expected: Contacts who have basketball in their registered sports will be shown. Details of the outcome of the findsport shown in the status message. + +3. Test case: `findsport s/chocolate`
+ Expected: Error message is shown as sport is not one of the registered sports. Details of the outcome of the findsport shown in the status message. + +4. Other incorrect findsport commands to try: `findsport`, `findsport all`, `...`
+ Expected: Similar to previous. + +### Finding persons who play a particular sport near a location + +#### Displaying a list of person who play specific sports + +1. Prerequisites: At least one person must play one of the sports in the list of sports provided. Postal Code must be valid. + +2. Test case: `findsport pc/402001 s/basketball`
+ Expected: Contacts who have basketball in their registered sports will be shown by ascending order of distance from the specified location. Details of the outcome of the findsport shown in the status message. + +3. Test case: `findsport pc/123456 s/tennis`
+ Expected: Error message is shown as postal code is not valid. Details of the outcome of the findsport shown in the status message. + +4. Test case: `findsport pc/402001 s/chocolate`
+ Expected: Error message is shown as sport is not in registered list of sports. Details of the outcome of the findsport shown in the status message. + +5. Other incorrect findsport commands to try: `findsport`, `findsport all`, `...`
+ Expected: Similar to previous. + +### Adding a game + +#### Adds a game to the gamelist + +1. Prerequisites: Game must be a registered sport. Date time must follow specified format. Postal Code must be valid. + +2. Test case: `addgame g/volleyball dt/2025-04-04T15:00:00 pc/402001`
+ Expected: Game will be added and the details of the game will be shown in the status message of addgame. + +3. Test case: `addgame g/tennis`
+ Expected: Error message is shown as date time and postal code not added. Details of the outcome of the addgame shown in the status message. + +4. Other incorrect addgame commands to try: `addgame`, `addgame g/chocolate`, `...`
+ Expected: Similar to previous. + +### Deleting a game + +#### Deletes a game from gamelist + +1. Prerequisites: At least one game must exist. + +2. Test case: `deletegame 1`
+ Expected: Game at index 1 will be deleted. Details of the outcome of the deletegame shown in the status message. + +3. Test case: `deletegame 0`
+ Expected: Error message is shown as postal index is not valid. Details of the outcome of the deletegame shown in the status message. + +4. Other incorrect deletegame commands to try: `deletegame`, `deletegame x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Adding a member to a game + +#### Adds a member to a game in the gamelist + +1. Prerequisites: At least one game must exist. The member must exist in the person list. + +2. Test case: `addmember g/1 n/Alice Pauline`
+ Expected: \"Alice Pauline\" will be added to game at index 1. Details of the outcome of the addmember shown in the status message. + +3. Test case: `addmember g/0 n/Alice Pauline`
+ Expected: Error message is shown as index is not valid. Details of the outcome of the addmember shown in the status message. - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. +4. Test case: `addmember g/1 n/Banana Man`
+ Expected: Error message is shown as contact is not in the person list. Details of the outcome of the addmember shown in the status message. - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. +5. Other incorrect addmember commands to try: `addmember g/1`, `addmember all`, `...`
+ Expected: Similar to previous. - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. +### Deleting a member from game - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. +#### Delets a member from a game in the gamelist -1. _{ more test cases … }_ +1. Prerequisites: At least one game must exist in the gamelist. Member must exist in the person list. -### Saving data +2. Test case: `deletemember g/1 n/Alice Pauline`
+ Expected: \"Alice Pauline\" will be deleted from game at index 1. Details of the outcome of the deletemember shown in the status message. -1. Dealing with missing/corrupted data files +3. Test case: `deletemember g/0 n/Alice Pauline`
+ Expected: Error message is shown as index is not valid. Details of the outcome of the deletemember shown in the status message. - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ +4. Test case: `deletemember g/1 n/Banana Man`
+ Expected: Error message is shown as contact is not in the person list. Details of the outcome of the deletemember shown in the status message. -1. _{ more test cases … }_ +5. Other incorrect deletemember commands to try: `deletemember g/1`, `deletemember all`, `...`
+ Expected: Similar to previous. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..ffe06c405c2 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,26 @@ +# FitFriends Theme Documentation +This site is built using GitHub Pages with Jekyll. + +## Theme Information + +This site uses the `jekyll-theme-primer` theme, which is one of the supported themes for GitHub Pages. + +## Troubleshooting Theme Issues + +If you encounter theme-related build errors: + +1. Ensure that the theme specified in `_config.yml` matches the theme actually used by GitHub Pages +2. Make sure `docs/assets/css/style.scss` imports stylesheets that are compatible with the chosen theme +3. If using custom styles, make sure they don't conflict with the theme + +## Local Development + +To test this documentation site locally: + +1. Install Ruby and Bundler +2. Navigate to the `docs` directory +3. Run `bundle install` to install dependencies +4. Run `bundle exec jekyll serve` to start a local server +5. Visit `http://localhost:4000` to view the site + +For more information, see the [GitHub Pages documentation](https://docs.github.com/en/pages). diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 27c2d1cf16c..23bd9124a3d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1,200 +1,579 @@ --- layout: page -title: User Guide +title: FitFriends User Guide --- +# FitFriends User Guide +*Last Updated: 7 Apr 2025* -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, 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, AB3 can get your contact management tasks done faster than traditional GUI apps. +
-* Table of Contents
-{:toc}
+## 🏆 Our Mission
---------------------------------------------------------------------------------------------------------------------
+FitFriends is designed to help **sporty young adults** connect, organize and participate in sports activities together. In today's busy world, finding friends with similar sporting interests and coordinating meetups can be challenging. FitFriends makes this process seamless and enjoyable.
-## Quick start
+*refers to adults between 16-35 years of age and are active or looking to get active in the sporting scene
-1. Ensure you have Java `17` or above installed in your Computer.
- **Mac users:** Ensure you have the precise JDK version prescribed [here](https://se-education.org/guides/tutorials/javaInstallationMac.html). +### 🎯 Problems We're Solving -1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases). +**Primary Challenge:** +- Difficulty in organizing sports meetups with friends who share similar interests in specific locations -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. +**Secondary Challenges:** +- Remembering which friends play which sports +- Finding suitable locations for sports activities based on everyone's location +- Discovering conversation topics related to sports interests -1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.
- A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
-  +### 💪 How FitFriends Helps You -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: +- **Sports-focused contact management:** Keep track of which friends play which sports +- **Location-based planning:** Sort friends by proximity to a specific location using postal codes +- **Game organization:** Create games for different sports or friend circles +- **Smart recommendations:** Find the perfect sports partners based on interests and location - * `list` : Lists all contacts. +> 📊 **Did you know?** According to our surveys, 78% of young adults want to try new sports but don't know who to play with. FitFriends helps you discover which friends might be interested in picking up new sports like tennis or pickleball together! - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. +--- + +## 📋 Table of Contents + + +- ️️Getting Started + - [System Requirements](#system-requirements) + - [Installation](#installation) + - [First Launch](#first-launch) +- ️️Using FitFriends + - [Interface Overview](#interface-overview) + - [Command Format](#command-format) +- ️️Basic Features + - [Viewing Help](#viewing-help) + - [Managing Contacts](#managing-contacts) + - [Sports Management](#sports-management) + - [Game Management](#game-management) +- Command Summary +- ️️Faqs +- ️️Troubleshooting +- ️️References + + +--- + +## 💻 Getting Started + +### System Requirements + +- **Operating System:** Windows 10/11, macOS 10.15+, or Linux +- **Java:** Version 17 or above ([Download here](https://www.oracle.com/java/technologies/downloads/)) +- **Storage:** Minimum 100MB free space +- **RAM:** Minimum 2GB (4GB recommended) + +### Installation + +1. **Download** the latest `FitFriends.jar` file from our [releases page](https://github.com/AY2425S2-CS2103T-F12-1/tp/releases). + +2. **Create a folder** where you want to store FitFriends data. + +3. **Move** the downloaded `.jar` file to this folder. + +### First Launch + +#### Using the Command Line Interface (CLI) +###### Learn more about CLI [here](https://www.techtarget.com/searchwindowsserver/definition/command-line-interface-CLI). + +1. **Open a terminal/command prompt** + - Windows: `Win + R` > type `cmd` + - macOS: `Cmd + Space` > type `terminal` + - Linux: `Ctrl + Alt + T` + +2. **Navigate to folder**: + ``` + cd path/to/your/fitfriends/folder + ``` + +3. **Launch the application**: + ``` + java -jar FitFriends.jar + ``` + +4. **You should see** the FitFriends interface. Congratulations! You're ready to start. + +#### Using the Graphical Interface + +1. **Double-click** on the FitFriends.jar file. + + > ⚠️ **If this doesn't work**: Your system might not have associated .jar files with Java. Use the CLI method above or right-click the file and select "Open with Java". + +2. **You should see** the FitFriends interface. Congratulations! You're ready to start. + +--- +## 🏋️️ Using FitFriends +### Interface Overview + +FitFriends combines the power of a Command Line Interface (CLI) with the convenience of a Graphical User Interface (GUI): + +- **Command Box**: Type your commands here and press Enter to execute +- **Result Display**: Shows the result of your command +- **Friend List**: Displays all your contacts with their information +- **Person Card**: Shows detailed information for each contact + +**Before you start**, we suggest: +> 💡 **Tip**: Expand the size of the GUI window by clicking on and dragging the sides outwards, which we have done in our examples below. + +> 💡 **Tip**: Switch to light and dark mode by clicking on the button at the top right of the interface. + + + + +### Command Format + +- Words in `UPPERCASE` are parameters to be supplied by you. +- Items in square brackets `[...]` are optional. +- Items with `...` after them can have multiple instances. +- Parameters can be in any order. + +> ⚠️ **Note**: Command words are case-sensitive, so you should only type `help`, and not `HELP`, `HeLp` or even `Help`. + +--- +## 🌟 Basic Features + +### Viewing Help + +Need assistance? The help command gives you quick access to instructions. + +**Format**: +``` +help +``` + +When you type `help` and press Enter, you'll see a pop-up that looks like this: + + + + +--- + +## Managing Contacts + +### Add Contact + +Add contacts to your FitFriends list with details that help plan sporting activities. + +**Format**: +``` +add n/NAME p/PHONE e/EMAIL a/ADDRESS [t/TAG] s/SPORT pc/POSTALCODE +``` + +**Example**: +``` +add n/John Doe p/98765432 e/johnd@example.com a/John Street, #01-01 t/bestfriend s/tennis pc/119077 +``` + +This adds John Doe to your list of contacts with his details and shows he plays tennis: + + + +> ⚠️ **Notes**: +> * Name: Names are case-insensitive (e.g., the names, Somneel and somneel, are the same and will not be allowed when adding a contact). +> * Adding a contact places them in the alphabetically sorted position in the list. +> * "s/o" will not be accepted as part of a name, we recommend you enter this part of your contact's name as "s_o", "so" or even "s o" instead. +> * Postal Code: Only valid Singapore postal codes are accepted. +> * Sport: Only valid sports from "Valid Sports List" are allowed. You can add valid sports to this list by using the `createsport` command. +> * Tag: Tags are optional. You can add as many tags as you want to a contact (e.g., `t/bestfriend t/colleague`). Tags help you categorize your contacts. + +### List All Contacts + +View all your contacts in one place. + +**Format**: +``` +list +``` + +This displays all your contacts in the left panel, sorted by alphabetical order: + + + +> ⚠️ **Notes**: +> * You should run this command after adding, deleting or editing contacts to see the updated list. +> * You should also run this command after running find or findsport commands to view the full list. + +### Edit Contact + +Update your contact's details as they change. + +**Format**: +``` +edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG] [pc/POSTALCODE] +``` - * `delete 3` : Deletes the 3rd contact shown in the current list. +**Example**: +``` +edit 2 n/James Lee p/87654321 a/45 Sunset Blvd pc/119077 +``` - * `clear` : Deletes all contacts. +This updates the 2nd contact in your current FitFriends list with a new name, phone number, address, and postal code: - * `exit` : Exits the app. + -1. Refer to the [Features](#features) below for details of each command. +> ⚠️ **Notes**: +> * Editing a tag will remove all existing tags as tags cannot be added sequentially (e.g., `edit t/bestfriend` followed by `edit t/colleague` will result in only the `colleague` tag remaining). +> * Adding a contact automatically places them in the alphabetically sorted position in the list. +> * "s/o" will not be accepted as part of a name, we recommend you enter this part of your contact's name as "s_o", "so" or even "s o" instead. --------------------------------------------------------------------------------------------------------------------- +### Find Contacts by Name -## Features +Quickly find contacts by searching for part of their name. -
-  +Update your FitFriends list if a contact no longer plays a particular sport. -### Deleting a person : `delete` +**Format**: +``` +deletesport INDEX s/SPORT +``` -Deletes the specified person from the address book. +**Example**: +``` +deletesport 2 s/basketball +``` -Format: `delete INDEX` +This removes basketball from the 2nd contact's list of played sports: -* Deletes the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, … + -Examples: -* `list` followed by `delete 2` deletes the 2nd person in the address book. -* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. +> ⚠️ **Note**: This command has the same command name as deleting a sport from the global sports list. To prevent accidental deletion of sport from global sports list, ensure you add "s/SPORT" at the end of this command to delete a sport from a contact. -### Clearing all entries : `clear` +### Find Contacts by Sport -Clears all entries from the address book. +Discover which contacts play specific sports—perfect for organizing game days! + +**Format**: +``` +findsport s/SPORT [s/SPORT] +``` + +**Example**: +``` +findsport s/basketball s/tennis +``` + +This shows all contacts who play either basketball or tennis (or both): + + + +> 💡 **Tip**: If you run edit, delete, addsport, deletesport commands immediately after this command, these commands will apply to the contact listed at the index as shown by the findsport command. Use this to manage your contacts without having to search for them manually! + +### Find Contacts by Sport and Location + +Find sports contacts near a specific location—ideal for planning convenient meetups! + +**Format**: +``` +findsport pc/POSTALCODE s/SPORT [s/SPORT] +``` + +**Example**: +``` +findsport pc/119077 s/tennis s/hockey +``` + +This shows all contacts who play tennis or hockey, sorted by their proximity to postal code 119077: + + + +> ⚠️ **Notes**: +> * Search keywords are case-insensitive +> * Proximity is calculated by contact's postal code +> * More than 1 sport can be included in the search by adding s/SPORT_NAME + +> 💡 **Tips**: +> * Use this feature to find the optimal meeting spot for your sports game! +> * If you run edit, delete, addsport, deletesport commands immediately after this command, these commands will apply to the contact listed at the index as shown by the findsport command. Use this to manage your contacts without having to search for them manually! + +--- -Format: `clear` +## Game Management -### Exiting the program : `exit` +### Add Game -Exits the program. +Organize your contacts into games for different activities or events. -Format: `exit` +**Format**: +``` +addgame g/SPORT_NAME dt/DATE_TIME pc/POSTAL_CODE +``` -### Saving the data +**Example**: +``` +addgame g/badminton dt/2025-04-01T15:00:00 pc/119077 +``` -AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +This creates a new game called "badminton": -### Editing the data file + -AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. +### Delete Game -
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +### Add Member to Game --------------------------------------------------------------------------------------------------------------------- +Adds contacts as members to a particular game -## Known issues +**Format**: +``` +addmember g/INDEX n/PERSON_NAME +``` -1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. -2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window. +**Example**: +``` +addmember g/1 n/John Doe +``` +This adds the contact with name John Doe to game at index 1: --------------------------------------------------------------------------------------------------------------------- + -## Command summary +### Delete Member from Game + +Delete members from a particular game + +**Format**: +``` +deletemember g/INDEX n/PERSON_NAME +``` + +**Example**: +``` +deletemember g/1 n/John Doe +``` + +This deletes the contact with name John Doe from game at index 1: + + + +### Edit Location of Game + +**Format**: + +Changes the location of an existing game +``` +editgamelocation g/INDEX pc/POSTAL_CODE +``` + +**Example**: +``` +editgamelocation g/1 pc/639798 +``` + +This changes the postal code of game at index 1 to 639798: + + +--- + +## 📝 Command Summary + +| **Action** | **Format** | **Example** | +|------------------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| **Viewing Help** | `help` | `help` | +| **Add Contact** | `add n/NAME p/PHONE e/EMAIL a/ADDRESS [t/TAG] s/SPORT pc/POSTALCODE` | `add n/John Doe p/98765432 e/johnd@example.com a/John St t/friend s/tennis pc/119077` | +| **List All Contacts** | `list` | `list` | +| **Edit Contact** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG] [pc/POSTALCODE]` | `edit 2 n/James Lee p/98765432 a/Block 123 pc/119077` | +| **Find Contacts by Name** | `find KEYWORD [MORE_KEYWORDS]` | `find James Jake` | +| **Delete Contact** | `delete INDEX` | `delete 3` | +| **Clear All Entries** | `clear` | `clear` | +| **Add new Sport to Global List of Sports** | `createsport s/SPORT_NAME` | `createsport s/archery` | +| **List All Sports** | `listsports` | `listsports` | +| **Delete Sport from Global List of Sports** | `deletesport INDEX` | `deletesport 1` | +| **Add Sport to Contact** | `addsport INDEX s/SPORT` | `addsport 1 s/tennis` | +| **Delete Sport from Contact** | `deletesport INDEX s/SPORT` | `deletesport 2 s/basketball` | +| **Find Contacts by Sport** | `findsport s/SPORT [s/SPORT]` | `findsport s/basketball s/tennis` | +| **Find Contacts by Sport and Location** | `findsport pc/POSTALCODE s/SPORT [s/SPORT]` | `findsport pc/119077 s/tennis s/hockey` | +| **Add Game** | `addgame g/SPORT_NAME dt/DATE_TIME pc/POSTAL_CODE` | `addgame g/volleyball dt/2025-04-04T15:30:00 pc/119077` | +| **Delete Game** | `deletegame INDEX` | `deletegame 1` | +| **Add Member to Game** | `addmember g/INDEX n/PERSON_NAME` | `addmember g/1 n/Alice Pauline` | +| **Delete Member from Game** | `deletemember g/INDEX n/PERSON_NAME` | `deletemember g/1 n/Alice Pauline` | +| **Edit Location of Game** | `editgamelocation g/INDEX pc/POSTAL_CODE` | `editgamelocation g/1 pc/119077` | + + + +--- +## 🙋 FAQs + +**Q: Can I use FitFriends to find sports facilities?** +A: Currently, FitFriends doesn't directly provide information about sports facilities, but it helps you coordinate with friends who live near specific locations by using findsport with postal codes. + +**Q: How many sports can I add per friend?** +A: There is no limit! Add as many sports as your friend plays. + +**Q: Can I import contacts from my phone?** +A: This feature is coming in our next update. Stay tuned! + +--- +## 🛠️ Troubleshooting + +**Problem: FitFriends won't start** +- Verify you have Java 17+ installed by running `java -version` in your terminal, if the version is correct, a message like this should appear: `java version "17.0.13" 2024-10-15 LTS` +- Try running FitFriends from the command line to see error messages and describe your problem to a generative AI model like ChatGPT. + +**Problem: Command not recognized** +- Check your spelling and format +- Refer to the Command Summary table for correct syntax + +**Still need help?** Visit our [support page](https://github.com/AY2425S2-CS2103T-F12-1/tp/issues) or email `fitfriends.support@gmail.com`. + +--- +## 📚 References + +1. [Benefits of sports in social bonding](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6125028/) +2. [The importance of location in sports participation](https://www.tandfonline.com/doi/full/10.1080/16184742.2019.1566931) +3. [Java documentation](https://docs.oracle.com/en/java/) + +--- -Action | Format, Examples ---------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**List** | `list` -**Help** | `help` +[Back to Top](#fitfriends-user-guide) diff --git a/docs/_config.yml b/docs/_config.yml index 6bd245d8f4e..048b0fc3a94 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,5 +1,5 @@ -title: "AB-3" -theme: minima +title: "FitFriends" +theme: jekyll-theme-primer header_pages: - UserGuide.md @@ -8,7 +8,7 @@ header_pages: markdown: kramdown -repository: "se-edu/addressbook-level3" +repository: "https://github.com/AY2425S2-CS2103T-F12-1/tp.git" github_icon: "images/github-icon.png" plugins: diff --git a/docs/_data/projects.yml b/docs/_data/projects.yml deleted file mode 100644 index 8f3e50cb601..00000000000 --- a/docs/_data/projects.yml +++ /dev/null @@ -1,23 +0,0 @@ -- name: "AB-1" - url: https://se-edu.github.io/addressbook-level1 - -- name: "AB-2" - url: https://se-edu.github.io/addressbook-level2 - -- name: "AB-3" - url: https://se-edu.github.io/addressbook-level3 - -- name: "AB-4" - url: https://se-edu.github.io/addressbook-level4 - -- name: "Duke" - url: https://se-edu.github.io/duke - -- name: "Collate" - url: https://se-edu.github.io/collate - -- name: "Book" - url: https://se-edu.github.io/se-book - -- name: "Resources" - url: https://se-edu.github.io/resources diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html deleted file mode 100644 index 8559a67ffad..00000000000 --- a/docs/_includes/custom-head.html +++ /dev/null @@ -1,6 +0,0 @@ -{% comment %} - Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: - - 1. Head over to https://realfavicongenerator.net/ to add your own favicons. - 2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. -{% endcomment %} diff --git a/docs/_includes/head.html b/docs/_includes/head.html deleted file mode 100644 index 83ac5326933..00000000000 --- a/docs/_includes/head.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - {%- include custom-head.html -%} - -{{page.title}}
-
-
diff --git a/docs/_includes/header.html b/docs/_includes/header.html
deleted file mode 100644
index 33badcd4f99..00000000000
--- a/docs/_includes/header.html
+++ /dev/null
@@ -1,36 +0,0 @@
-
-
-
diff --git a/docs/_layouts/alt-page.html b/docs/_layouts/alt-page.html
deleted file mode 100644
index 5dbc6ef245f..00000000000
--- a/docs/_layouts/alt-page.html
+++ /dev/null
@@ -1,14 +0,0 @@
----
-layout: default
----
-
-
-
-
-
-
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
deleted file mode 100644
index e092cd572e0..00000000000
--- a/docs/_layouts/default.html
+++ /dev/null
@@ -1,18 +0,0 @@
-
-
-
- {%- include head.html -%}
-
-
-
- {%- include header.html -%}
-
-
-
-
-
-
-
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
deleted file mode 100644
index 01e4b2a93b8..00000000000
--- a/docs/_layouts/page.html
+++ /dev/null
@@ -1,14 +0,0 @@
----
-layout: default
----
-
-
-
-
-
-
diff --git a/docs/_sass/minima/_base.scss b/docs/_sass/minima/_base.scss
deleted file mode 100644
index 0d3f6e80ced..00000000000
--- a/docs/_sass/minima/_base.scss
+++ /dev/null
@@ -1,295 +0,0 @@
-html {
- font-size: $base-font-size;
-}
-
-/**
- * Reset some basic elements
- */
-body, h1, h2, h3, h4, h5, h6,
-p, blockquote, pre, hr,
-dl, dd, ol, ul, figure {
- margin: 0;
- padding: 0;
-
-}
-
-
-
-/**
- * Basic styling
- */
-body {
- font: $base-font-weight #{$base-font-size}/#{$base-line-height} $base-font-family;
- color: $text-color;
- background-color: $background-color;
- -webkit-text-size-adjust: 100%;
- -webkit-font-feature-settings: "kern" 1;
- -moz-font-feature-settings: "kern" 1;
- -o-font-feature-settings: "kern" 1;
- font-feature-settings: "kern" 1;
- font-kerning: normal;
- display: flex;
- min-height: 100vh;
- flex-direction: column;
- overflow-wrap: break-word;
-}
-
-
-
-/**
- * Set `margin-bottom` to maintain vertical rhythm
- */
-h1, h2, h3, h4, h5, h6,
-p, blockquote, pre,
-ul, ol, dl, figure,
-%vertical-rhythm {
- margin-bottom: $spacing-unit / 2;
-}
-
-hr {
- margin-top: $spacing-unit;
- margin-bottom: $spacing-unit;
-}
-
-/**
- * `main` element
- */
-main {
- display: block; /* Default value of `display` of `main` element is 'inline' in IE 11. */
-}
-
-
-
-/**
- * Images
- */
-img {
- max-width: 100%;
- vertical-align: middle;
-}
-
-
-
-/**
- * Figures
- */
-figure > img {
- display: block;
-}
-
-figcaption {
- font-size: $small-font-size;
-}
-
-
-
-/**
- * Lists
- */
-ul, ol {
- margin-left: $spacing-unit;
-}
-
-li {
- > ul,
- > ol {
- margin-bottom: 0;
- }
-}
-
-
-
-/**
- * Headings
- */
-h1, h2, h3, h4, h5, h6 {
- font-weight: $base-font-weight;
-}
-
-
-
-/**
- * Links
- */
-a {
- color: $link-base-color;
- text-decoration: none;
-
- &:visited {
- color: $link-visited-color;
- }
-
- &:hover {
- color: $text-color;
- text-decoration: underline;
- }
-
- .social-media-list &:hover {
- text-decoration: none;
-
- .username {
- text-decoration: underline;
- }
- }
-}
-
-
-/**
- * Blockquotes
- */
-blockquote {
- color: $brand-color;
- border-left: 4px solid $brand-color-light;
- padding-left: $spacing-unit / 2;
- @include relative-font-size(1.125);
- font-style: italic;
-
- > :last-child {
- margin-bottom: 0;
- }
-
- i, em {
- font-style: normal;
- }
-}
-
-
-
-/**
- * Code formatting
- */
-pre,
-code {
- font-family: $code-font-family;
- font-size: 0.9375em;
- border: 1px solid $brand-color-light;
- border-radius: 3px;
- background-color: $code-background-color;
-}
-
-code {
- padding: 1px 5px;
-}
-
-pre {
- padding: 8px 12px;
- overflow-x: auto;
-
- > code {
- border: 0;
- padding-right: 0;
- padding-left: 0;
- }
-}
-
-.highlight {
- border-radius: 3px;
- background: $code-background-color;
- @extend %vertical-rhythm;
-
- .highlighter-rouge & {
- background: $code-background-color;
- }
-}
-
-
-
-/**
- * Wrapper
- */
-.wrapper {
- max-width: calc(#{$content-width} - (#{$spacing-unit}));
- margin-right: auto;
- margin-left: auto;
- padding-right: $spacing-unit / 2;
- padding-left: $spacing-unit / 2;
- @extend %clearfix;
-
- @media screen and (min-width: $on-large) {
- max-width: calc(#{$content-width} - (#{$spacing-unit} * 2));
- padding-right: $spacing-unit;
- padding-left: $spacing-unit;
- }
-}
-
-
-
-/**
- * Clearfix
- */
-%clearfix:after {
- content: "";
- display: table;
- clear: both;
-}
-
-
-
-/**
- * Icons
- */
-
-.orange {
- color: #f66a0a;
-}
-
-.grey {
- color: #828282;
-}
-
-/**
- * Tables
- */
-table {
- margin-bottom: $spacing-unit;
- width: 100%;
- text-align: $table-text-align;
- color: $table-text-color;
- border-collapse: collapse;
- border: 1px solid $table-border-color;
- tr {
- &:nth-child(even) {
- background-color: $table-zebra-color;
- }
- }
- th, td {
- padding: ($spacing-unit / 3) ($spacing-unit / 2);
- }
- th {
- background-color: $table-header-bg-color;
- border: 1px solid $table-header-border;
- }
- td {
- border: 1px solid $table-border-color;
- }
-
- @include media-query($on-laptop) {
- display: block;
- overflow-x: auto;
- -webkit-overflow-scrolling: touch;
- -ms-overflow-style: -ms-autohiding-scrollbar;
- }
-}
-
-@media print {
- /**
- * Prevents page break from cutting through content when printing
- */
- body {
- display: block;
- }
- /**
- * Replaces the top navigation menu with the project name when printing
- */
- .site-header .wrapper {
- display: none;
- }
- .site-header {
- text-align: center;
- }
- .site-header:before {
- content: "AB-3";
- font-size: 32px;
- }
-}
-
diff --git a/docs/_sass/minima/_layout.scss b/docs/_sass/minima/_layout.scss
deleted file mode 100644
index ca99f981701..00000000000
--- a/docs/_sass/minima/_layout.scss
+++ /dev/null
@@ -1,263 +0,0 @@
-/**
- * Site header
- */
-.site-header {
- border-top: 5px solid $brand-color-dark;
- border-bottom: 1px solid $brand-color-light;
- min-height: $spacing-unit * 1.865;
- line-height: $base-line-height * $base-font-size * 2.25;
-
- // Positioning context for the mobile navigation icon
- position: relative;
-}
-
-.site-title {
- @include relative-font-size(1.625);
- font-weight: 300;
- letter-spacing: -1px;
- margin-bottom: 0;
- float: left;
-
- @include media-query($on-palm) {
- padding-right: 45px;
- }
-
- &,
- &:visited {
- color: $brand-color-dark;
- }
-}
-
-.site-nav {
- position: absolute;
- top: 9px;
- right: $spacing-unit / 2;
- background-color: $background-color;
- border: 1px solid $brand-color-light;
- border-radius: 5px;
- text-align: right;
-
- .nav-trigger {
- display: none;
- }
-
- .menu-icon {
- float: right;
- width: 36px;
- height: 26px;
- line-height: 0;
- padding-top: 10px;
- text-align: center;
-
- > svg path {
- fill: $brand-color-dark;
- }
- }
-
- label[for="nav-trigger"] {
- display: block;
- float: right;
- width: 36px;
- height: 36px;
- z-index: 2;
- cursor: pointer;
- }
-
- input ~ .trigger {
- clear: both;
- display: none;
- }
-
- input:checked ~ .trigger {
- display: block;
- padding-bottom: 5px;
- }
-
- .page-link {
- color: $text-color;
- line-height: $base-line-height;
- display: block;
- padding: 5px 10px;
-
- // Gaps between nav items, but not on the last one
- &:not(:last-child) {
- margin-right: 0;
- }
- margin-left: 20px;
- }
-
- @media screen and (min-width: $on-medium) {
- position: static;
- float: right;
- border: none;
- background-color: inherit;
-
- label[for="nav-trigger"] {
- display: none;
- }
-
- .menu-icon {
- display: none;
- }
-
- input ~ .trigger {
- display: block;
- }
-
- .page-link {
- display: inline;
- padding: 0;
-
- &:not(:last-child) {
- margin-right: 20px;
- }
- margin-left: auto;
- }
- }
-}
-
-
-
-/**
- * Page content
- */
-.page-content {
- padding: $spacing-unit 0;
- flex: 1 0 auto;
-}
-
-.page-heading {
- @include relative-font-size(2);
-}
-
-.post-list-heading {
- @include relative-font-size(1.75);
-}
-
-.post-list {
- margin-left: 0;
- list-style: none;
-
- > li {
- margin-bottom: $spacing-unit;
- }
-}
-
-.post-meta {
- font-size: $small-font-size;
- color: $brand-color;
-}
-
-.post-link {
- display: block;
- @include relative-font-size(1.5);
-}
-
-
-
-/**
- * Posts
- */
-.post-header {
- margin-bottom: $spacing-unit;
-}
-
-.post-title,
-.post-content h1 {
- @include relative-font-size(2.625);
- letter-spacing: -1px;
- line-height: 1.15;
-
- @media screen and (min-width: $on-large) {
- @include relative-font-size(2.625);
- }
-}
-
-.post-content {
- margin-bottom: $spacing-unit;
-
- h1, h2, h3 { margin-top: $spacing-unit * 2 }
- h4, h5, h6 { margin-top: $spacing-unit }
-
- h2 {
- @include relative-font-size(1.75);
-
- @media screen and (min-width: $on-large) {
- @include relative-font-size(2);
- }
- }
-
- h3 {
- @include relative-font-size(1.375);
-
- @media screen and (min-width: $on-large) {
- @include relative-font-size(1.625);
- }
- }
-
- h4 {
- @include relative-font-size(1.25);
- }
-
- h5 {
- @include relative-font-size(1.125);
- }
- h6 {
- @include relative-font-size(1.0625);
- }
-}
-
-
-.social-media-list {
- display: table;
- margin: 0 auto;
- li {
- float: left;
- margin: 5px 10px 5px 0;
- &:last-of-type { margin-right: 0 }
- a {
- display: block;
- padding: $spacing-unit / 4;
- border: 1px solid $brand-color-light;
- &:hover { border-color: darken($brand-color-light, 10%) }
- }
- }
-}
-
-
-
-/**
- * Pagination navbar
- */
-.pagination {
- margin-bottom: $spacing-unit;
- @extend .social-media-list;
- li {
- a, div {
- min-width: 41px;
- text-align: center;
- box-sizing: border-box;
- }
- div {
- display: block;
- padding: $spacing-unit / 4;
- border: 1px solid transparent;
-
- &.pager-edge {
- color: darken($brand-color-light, 5%);
- border: 1px dashed;
- }
- }
- }
-}
-
-
-
-/**
- * Grid helpers
- */
-@media screen and (min-width: $on-large) {
- .one-half {
- width: calc(50% - (#{$spacing-unit} / 2));
- }
-}
diff --git a/docs/_sass/minima/custom-mixins.scss b/docs/_sass/minima/custom-mixins.scss
deleted file mode 100644
index 9d4bedc1c67..00000000000
--- a/docs/_sass/minima/custom-mixins.scss
+++ /dev/null
@@ -1,21 +0,0 @@
-@mixin alert-variant($background, $border, $color) {
- color: $color;
- @include gradient-bg($background);
- border-color: $border;
-
- .alert-link {
- color: darken($color, 10%);
- }
-}
-
-@mixin gradient-bg($color, $foreground: null) {
- @if $enable-gradients {
- @if $foreground {
- background-image: $foreground, linear-gradient(180deg, mix($body-bg, $color, 15%), $color);
- } @else {
- background-image: linear-gradient(180deg, mix($body-bg, $color, 15%), $color);
- }
- } @else {
- background-color: $color;
- }
-}
diff --git a/docs/_sass/minima/custom-styles.scss b/docs/_sass/minima/custom-styles.scss
deleted file mode 100644
index 56b5d56b430..00000000000
--- a/docs/_sass/minima/custom-styles.scss
+++ /dev/null
@@ -1,34 +0,0 @@
-// Placeholder to allow defining custom styles that override everything else.
-// (Use `_sass/minima/custom-variables.scss` to override variable defaults)
-h2, h3, h4, h5, h6 {
- color: #e46c0a;
-}
-
-// Bootstrap style alerts
-.alert {
- position: relative;
- padding: $alert-padding-y $alert-padding-x;
- margin-bottom: $alert-margin-bottom;
- border: $alert-border-width solid transparent;
- border-radius : $alert-border-radius;
-}
-
-// Headings for larger alerts
-.alert-heading {
- // Specified to prevent conflicts of changing $headings-color
- color: inherit;
-}
-
-// Provide class for links that match alerts
-.alert-link {
- font-weight: $alert-link-font-weight;
-}
-
-// Generate contextual modifier classes for colorizing the alert.
-
-@each $color, $value in $theme-colors {
- .alert-#{$color} {
- @include alert-variant(color-level($value, $alert-bg-level), color-level($value, $alert-border-level), color-level($value, $alert-color-level));
- }
-}
-
diff --git a/docs/_sass/minima/custom-variables.scss b/docs/_sass/minima/custom-variables.scss
deleted file mode 100644
index a128970cbe7..00000000000
--- a/docs/_sass/minima/custom-variables.scss
+++ /dev/null
@@ -1,76 +0,0 @@
-// Placeholder to allow overriding predefined variables smoothly.
-
-//Bootstrap's default
-$white: #fff !default;
-$gray-100: #f8f9fa !default;
-$gray-200: #e9ecef !default;
-$gray-300: #dee2e6 !default;
-$gray-400: #ced4da !default;
-$gray-500: #adb5bd !default;
-$gray-600: #6c757d !default;
-$gray-700: #495057 !default;
-$gray-800: #343a40 !default;
-$gray-900: #212529 !default;
-$black: #000 !default;
-$blue: #0d6efd !default;
-$indigo: #6610f2 !default;
-$purple: #6f42c1 !default;
-$pink: #d63384 !default;
-$red: #dc3545 !default;
-$orange: #fd7e14 !default;
-$yellow: #ffc107 !default;
-$green: #28a745 !default;
-$teal: #20c997 !default;
-$cyan: #17a2b8 !default;
-
-$primary: $blue !default;
-$secondary: $gray-600 !default;
-$success: $green !default;
-$info: $cyan !default;
-$warning: $yellow !default;
-$danger: $red !default;
-$light: $gray-100 !default;
-$dark: $gray-800 !default;
-
-$theme-colors: (
- "primary": $primary,
- "secondary": $secondary,
- "success": $success,
- "info": $info,
- "warning": $warning,
- "danger": $danger,
- "light": $light,
- "dark": $dark
-) !default;
-
-$theme-color-interval: 8% !default;
-
-$body-bg: $white !default;
-$body-color: $gray-900 !default;
-$body-text-align: null !default;
-
-$enable-gradients: true;
-
-// Define alert colors, border radius, and padding.
-$border-radius: .25rem !default;
-$border-width: 1px !default;
-$font-weight-bold: 700 !default;
-
-$alert-padding-y: .75rem !default;
-$alert-padding-x: 1.25rem !default;
-$alert-margin-bottom: 1rem !default;
-$alert-border-radius: $border-radius !default;
-$alert-link-font-weight: $font-weight-bold !default;
-$alert-border-width: $border-width !default;
-
-$alert-bg-level: -10 !default;
-$alert-border-level: -9 !default;
-$alert-color-level: 6 !default;
-
-// Request a color level
-// scss-docs-start color-level
-@function color-level($color: $primary, $level: 0) {
- $color-base: if($level > 0, $black, $white);
- $level: abs($level);
- @return mix($color-base, $color, $level * $theme-color-interval);
-}
diff --git a/docs/_sass/minima/initialize.scss b/docs/_sass/minima/initialize.scss
deleted file mode 100644
index 30288811151..00000000000
--- a/docs/_sass/minima/initialize.scss
+++ /dev/null
@@ -1,51 +0,0 @@
-@charset "utf-8";
-
-// Define defaults for each variable.
-
-$base-font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Segoe UI Symbol", "Segoe UI Emoji", "Apple Color Emoji", Roboto, Helvetica, Arial, sans-serif !default;
-$code-font-family: "Menlo", "Inconsolata", "Consolas", "Roboto Mono", "Ubuntu Mono", "Liberation Mono", "Courier New", monospace;
-$base-font-size: 16px !default;
-$base-font-weight: 400 !default;
-$small-font-size: $base-font-size * 0.875 !default;
-$base-line-height: 1.5 !default;
-
-$spacing-unit: 30px !default;
-
-$table-text-align: left !default;
-
-// Width of the content area
-$content-width: 800px !default;
-
-$on-palm: 600px !default;
-$on-laptop: 800px !default;
-
-$on-medium: $on-palm !default;
-$on-large: $on-laptop !default;
-
-// Use media queries like this:
-// @include media-query($on-palm) {
-// .wrapper {
-// padding-right: $spacing-unit / 2;
-// padding-left: $spacing-unit / 2;
-// }
-// }
-// Notice the following mixin uses max-width, in a deprecated, desktop-first
-// approach, whereas media queries used elsewhere now use min-width.
-@mixin media-query($device) {
- @media screen and (max-width: $device) {
- @content;
- }
-}
-
-@mixin relative-font-size($ratio) {
- font-size: #{$ratio}rem;
-}
-
-// Import pre-styling-overrides hook and style-partials.
-@import
- "minima/custom-variables", // Hook to override predefined variables.
- "minima/custom-mixins", // Hook to add custom mixins.
- "minima/base", // Defines element resets.
- "minima/layout", // Defines structure and style based on CSS selectors.
- "minima/custom-styles" // Hook to override existing styles.
-;
diff --git a/docs/_sass/minima/skins/classic.scss b/docs/_sass/minima/skins/classic.scss
deleted file mode 100644
index 37ea9c5244c..00000000000
--- a/docs/_sass/minima/skins/classic.scss
+++ /dev/null
@@ -1,84 +0,0 @@
-@charset "utf-8";
-
-$brand-color: #828282 !default;
-$brand-color-light: lighten($brand-color, 40%) !default;
-$brand-color-dark: darken($brand-color, 25%) !default;
-
-$text-color: #111 !default;
-$background-color: #fdfdfd !default;
-$code-background-color: #eef !default;
-
-$link-base-color: #2a7ae2 !default;
-$link-visited-color: darken($link-base-color, 15%) !default;
-
-$table-text-color: lighten($text-color, 18%) !default;
-$table-zebra-color: lighten($brand-color, 46%) !default;
-$table-header-bg-color: lighten($brand-color, 43%) !default;
-$table-header-border: lighten($brand-color, 36%) !default;
-$table-border-color: $brand-color-light !default;
-
-
-// Syntax highlighting styles should be adjusted appropriately for every "skin"
-// ----------------------------------------------------------------------------
-
-.highlight {
- .c { color: #998; font-style: italic } // Comment
- .err { color: #a61717; background-color: #e3d2d2 } // Error
- .k { font-weight: bold } // Keyword
- .o { font-weight: bold } // Operator
- .cm { color: #998; font-style: italic } // Comment.Multiline
- .cp { color: #999; font-weight: bold } // Comment.Preproc
- .c1 { color: #998; font-style: italic } // Comment.Single
- .cs { color: #999; font-weight: bold; font-style: italic } // Comment.Special
- .gd { color: #000; background-color: #fdd } // Generic.Deleted
- .gd .x { color: #000; background-color: #faa } // Generic.Deleted.Specific
- .ge { font-style: italic } // Generic.Emph
- .gr { color: #a00 } // Generic.Error
- .gh { color: #999 } // Generic.Heading
- .gi { color: #000; background-color: #dfd } // Generic.Inserted
- .gi .x { color: #000; background-color: #afa } // Generic.Inserted.Specific
- .go { color: #888 } // Generic.Output
- .gp { color: #555 } // Generic.Prompt
- .gs { font-weight: bold } // Generic.Strong
- .gu { color: #aaa } // Generic.Subheading
- .gt { color: #a00 } // Generic.Traceback
- .kc { font-weight: bold } // Keyword.Constant
- .kd { font-weight: bold } // Keyword.Declaration
- .kp { font-weight: bold } // Keyword.Pseudo
- .kr { font-weight: bold } // Keyword.Reserved
- .kt { color: #458; font-weight: bold } // Keyword.Type
- .m { color: #099 } // Literal.Number
- .s { color: #d14 } // Literal.String
- .na { color: #008080 } // Name.Attribute
- .nb { color: #0086B3 } // Name.Builtin
- .nc { color: #458; font-weight: bold } // Name.Class
- .no { color: #008080 } // Name.Constant
- .ni { color: #800080 } // Name.Entity
- .ne { color: #900; font-weight: bold } // Name.Exception
- .nf { color: #900; font-weight: bold } // Name.Function
- .nn { color: #555 } // Name.Namespace
- .nt { color: #000080 } // Name.Tag
- .nv { color: #008080 } // Name.Variable
- .ow { font-weight: bold } // Operator.Word
- .w { color: #bbb } // Text.Whitespace
- .mf { color: #099 } // Literal.Number.Float
- .mh { color: #099 } // Literal.Number.Hex
- .mi { color: #099 } // Literal.Number.Integer
- .mo { color: #099 } // Literal.Number.Oct
- .sb { color: #d14 } // Literal.String.Backtick
- .sc { color: #d14 } // Literal.String.Char
- .sd { color: #d14 } // Literal.String.Doc
- .s2 { color: #d14 } // Literal.String.Double
- .se { color: #d14 } // Literal.String.Escape
- .sh { color: #d14 } // Literal.String.Heredoc
- .si { color: #d14 } // Literal.String.Interpol
- .sx { color: #d14 } // Literal.String.Other
- .sr { color: #009926 } // Literal.String.Regex
- .s1 { color: #d14 } // Literal.String.Single
- .ss { color: #990073 } // Literal.String.Symbol
- .bp { color: #999 } // Name.Builtin.Pseudo
- .vc { color: #008080 } // Name.Variable.Class
- .vg { color: #008080 } // Name.Variable.Global
- .vi { color: #008080 } // Name.Variable.Instance
- .il { color: #099 } // Literal.Number.Integer.Long
-}
diff --git a/docs/_sass/minima/skins/solarized-dark.scss b/docs/_sass/minima/skins/solarized-dark.scss
deleted file mode 100644
index f3b1f387de0..00000000000
--- a/docs/_sass/minima/skins/solarized-dark.scss
+++ /dev/null
@@ -1,4 +0,0 @@
-@charset "utf-8";
-
-$sol-is-dark: true;
-@import "minima/skins/solarized";
diff --git a/docs/_sass/minima/skins/solarized.scss b/docs/_sass/minima/skins/solarized.scss
deleted file mode 100644
index 982bd7f2990..00000000000
--- a/docs/_sass/minima/skins/solarized.scss
+++ /dev/null
@@ -1,133 +0,0 @@
-@charset "utf-8";
-
-// Solarized skin
-// ==============
-// Created by Sander Voerman using the Solarized
-// color scheme by Ethan Schoonover .
-
-// This style sheet implements two options for the minima.skin setting:
-// "solarized" for light mode and "solarized-dark" for dark mode.
-$sol-is-dark: false !default;
-
-
-// Color scheme
-// ------------
-// The inline comments show the canonical L*a*b values for each color.
-
-$sol-base03: #002b36; // 15 -12 -12
-$sol-base02: #073642; // 20 -12 -12
-$sol-base01: #586e75; // 45 -07 -07
-$sol-base00: #657b83; // 50 -07 -07
-$sol-base0: #839496; // 60 -06 -03
-$sol-base1: #93a1a1; // 65 -05 -02
-$sol-base2: #eee8d5; // 92 -00 10
-$sol-base3: #fdf6e3; // 97 00 10
-$sol-yellow: #b58900; // 60 10 65
-$sol-orange: #cb4b16; // 50 50 55
-$sol-red: #dc322f; // 50 65 45
-$sol-magenta: #d33682; // 50 65 -05
-$sol-violet: #6c71c4; // 50 15 -45
-$sol-blue: #268bd2; // 55 -10 -45
-$sol-cyan: #2aa198; // 60 -35 -05
-$sol-green: #859900; // 60 -20 65
-
-$sol-mono3: $sol-base3;
-$sol-mono2: $sol-base2;
-$sol-mono1: $sol-base1;
-$sol-mono00: $sol-base00;
-$sol-mono01: $sol-base01;
-
-@if $sol-is-dark {
- $sol-mono3: $sol-base03;
- $sol-mono2: $sol-base02;
- $sol-mono1: $sol-base01;
- $sol-mono00: $sol-base0;
- $sol-mono01: $sol-base1;
-}
-
-
-// Minima color variables
-// ----------------------
-
-$brand-color: $sol-mono1 !default;
-$brand-color-light: mix($sol-mono1, $sol-mono3) !default;
-$brand-color-dark: $sol-mono00 !default;
-
-$text-color: $sol-mono01 !default;
-$background-color: $sol-mono3 !default;
-$code-background-color: $sol-mono2 !default;
-
-$link-base-color: $sol-blue !default;
-$link-visited-color: mix($sol-blue, $sol-mono00) !default;
-
-$table-text-color: $sol-mono00 !default;
-$table-zebra-color: mix($sol-mono2, $sol-mono3) !default;
-$table-header-bg-color: $sol-mono2 !default;
-$table-header-border: $sol-mono1 !default;
-$table-border-color: $sol-mono1 !default;
-
-
-// Syntax highlighting styles
-// --------------------------
-
-.highlight {
- .c { color: $sol-mono1; font-style: italic } // Comment
- .err { color: $sol-red } // Error
- .k { color: $sol-mono01; font-weight: bold } // Keyword
- .o { color: $sol-mono01; font-weight: bold } // Operator
- .cm { color: $sol-mono1; font-style: italic } // Comment.Multiline
- .cp { color: $sol-mono1; font-weight: bold } // Comment.Preproc
- .c1 { color: $sol-mono1; font-style: italic } // Comment.Single
- .cs { color: $sol-mono1; font-weight: bold; font-style: italic } // Comment.Special
- .gd { color: $sol-red } // Generic.Deleted
- .gd .x { color: $sol-red } // Generic.Deleted.Specific
- .ge { color: $sol-mono00; font-style: italic } // Generic.Emph
- .gr { color: $sol-red } // Generic.Error
- .gh { color: $sol-mono1 } // Generic.Heading
- .gi { color: $sol-green } // Generic.Inserted
- .gi .x { color: $sol-green } // Generic.Inserted.Specific
- .go { color: $sol-mono00 } // Generic.Output
- .gp { color: $sol-mono00 } // Generic.Prompt
- .gs { color: $sol-mono01; font-weight: bold } // Generic.Strong
- .gu { color: $sol-mono1 } // Generic.Subheading
- .gt { color: $sol-red } // Generic.Traceback
- .kc { color: $sol-mono01; font-weight: bold } // Keyword.Constant
- .kd { color: $sol-mono01; font-weight: bold } // Keyword.Declaration
- .kp { color: $sol-mono01; font-weight: bold } // Keyword.Pseudo
- .kr { color: $sol-mono01; font-weight: bold } // Keyword.Reserved
- .kt { color: $sol-violet; font-weight: bold } // Keyword.Type
- .m { color: $sol-cyan } // Literal.Number
- .s { color: $sol-magenta } // Literal.String
- .na { color: $sol-cyan } // Name.Attribute
- .nb { color: $sol-blue } // Name.Builtin
- .nc { color: $sol-violet; font-weight: bold } // Name.Class
- .no { color: $sol-cyan } // Name.Constant
- .ni { color: $sol-violet } // Name.Entity
- .ne { color: $sol-violet; font-weight: bold } // Name.Exception
- .nf { color: $sol-blue; font-weight: bold } // Name.Function
- .nn { color: $sol-mono00 } // Name.Namespace
- .nt { color: $sol-blue } // Name.Tag
- .nv { color: $sol-cyan } // Name.Variable
- .ow { color: $sol-mono01; font-weight: bold } // Operator.Word
- .w { color: $sol-mono1 } // Text.Whitespace
- .mf { color: $sol-cyan } // Literal.Number.Float
- .mh { color: $sol-cyan } // Literal.Number.Hex
- .mi { color: $sol-cyan } // Literal.Number.Integer
- .mo { color: $sol-cyan } // Literal.Number.Oct
- .sb { color: $sol-magenta } // Literal.String.Backtick
- .sc { color: $sol-magenta } // Literal.String.Char
- .sd { color: $sol-magenta } // Literal.String.Doc
- .s2 { color: $sol-magenta } // Literal.String.Double
- .se { color: $sol-magenta } // Literal.String.Escape
- .sh { color: $sol-magenta } // Literal.String.Heredoc
- .si { color: $sol-magenta } // Literal.String.Interpol
- .sx { color: $sol-magenta } // Literal.String.Other
- .sr { color: $sol-green } // Literal.String.Regex
- .s1 { color: $sol-magenta } // Literal.String.Single
- .ss { color: $sol-magenta } // Literal.String.Symbol
- .bp { color: $sol-mono1 } // Name.Builtin.Pseudo
- .vc { color: $sol-cyan } // Name.Variable.Class
- .vg { color: $sol-cyan } // Name.Variable.Global
- .vi { color: $sol-cyan } // Name.Variable.Instance
- .il { color: $sol-cyan } // Literal.Number.Integer.Long
-}
diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
deleted file mode 100644
index b5ec6976efa..00000000000
--- a/docs/assets/css/style.scss
+++ /dev/null
@@ -1,12 +0,0 @@
----
-# Only the main Sass file needs front matter (the dashes are enough)
----
-
-@import
- "minima/skins/{{ site.minima.skin | default: 'classic' }}",
- "minima/initialize";
-
-.icon {
- height: 21px;
- width: 21px
-}
diff --git a/docs/diagrams/AddSportSequenceDiagram.png b/docs/diagrams/AddSportSequenceDiagram.png
new file mode 100644
index 00000000000..d5c56acf601
Binary files /dev/null and b/docs/diagrams/AddSportSequenceDiagram.png differ
diff --git a/docs/diagrams/AddSportSequenceDiagram.puml b/docs/diagrams/AddSportSequenceDiagram.puml
new file mode 100644
index 00000000000..2b265bb62b7
--- /dev/null
+++ b/docs/diagrams/AddSportSequenceDiagram.puml
@@ -0,0 +1,70 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":AddSportCommandParser" as AddSportCommandParser LOGIC_COLOR
+participant "d:AddSportCommand" as AddSportCommand LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "m:Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("addsport s/Badminton")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("addsport s/Badminton")
+activate AddressBookParser
+
+create AddSportCommandParser
+AddressBookParser -> AddSportCommandParser
+activate AddSportCommandParser
+
+AddSportCommandParser --> AddressBookParser
+deactivate AddSportCommandParser
+
+AddressBookParser -> AddSportCommandParser : parse("s/Badminton")
+activate AddSportCommandParser
+
+create AddSportCommand
+AddSportCommandParser -> AddSportCommand
+activate AddSportCommand
+
+AddSportCommand --> AddSportCommandParser
+deactivate AddSportCommand
+
+AddSportCommandParser --> AddressBookParser : d
+deactivate AddSportCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+AddSportCommandParser -[hidden]-> AddressBookParser
+destroy AddSportCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+
+LogicManager -> AddSportCommand : execute(m)
+activate AddSportCommand
+
+AddSportCommand -> Model : addSport("Badminton")
+activate Model
+
+Model --> AddSportCommand
+deactivate Model
+
+create CommandResult
+AddSportCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> AddSportCommand
+deactivate CommandResult
+
+AddSportCommand --> LogicManager : r
+deactivate AddSportCommand
+
+[<-- LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/ArchitectureDiagram.png b/docs/diagrams/ArchitectureDiagram.png
new file mode 100644
index 00000000000..2df7d378301
Binary files /dev/null and b/docs/diagrams/ArchitectureDiagram.png differ
diff --git a/docs/diagrams/ArchitectureSequenceDiagram.png b/docs/diagrams/ArchitectureSequenceDiagram.png
new file mode 100644
index 00000000000..ed406dc5519
Binary files /dev/null and b/docs/diagrams/ArchitectureSequenceDiagram.png differ
diff --git a/docs/diagrams/BetterModelClassDiagram.png b/docs/diagrams/BetterModelClassDiagram.png
new file mode 100644
index 00000000000..5c39d740dac
Binary files /dev/null and b/docs/diagrams/BetterModelClassDiagram.png differ
diff --git a/docs/diagrams/BetterModelClassDiagram.puml b/docs/diagrams/BetterModelClassDiagram.puml
index 598474a5c82..d27d3e0bdc0 100644
--- a/docs/diagrams/BetterModelClassDiagram.puml
+++ b/docs/diagrams/BetterModelClassDiagram.puml
@@ -18,4 +18,8 @@ Person *--> Name
Person *--> Phone
Person *--> Email
Person *--> Address
+
+AddressBook *-right-> "1" UniqueGroupList
+UniqueGroupList -right-> "*" Group
+Group -down-> "*" Person
@enduml
diff --git a/docs/diagrams/CommitActivityDiagram.png b/docs/diagrams/CommitActivityDiagram.png
new file mode 100644
index 00000000000..1129ddf516b
Binary files /dev/null and b/docs/diagrams/CommitActivityDiagram.png differ
diff --git a/docs/diagrams/ComponentManagers.png b/docs/diagrams/ComponentManagers.png
new file mode 100644
index 00000000000..c40e390d50a
Binary files /dev/null and b/docs/diagrams/ComponentManagers.png differ
diff --git a/docs/diagrams/CreateSportSequenceDiagram.png b/docs/diagrams/CreateSportSequenceDiagram.png
new file mode 100644
index 00000000000..5966dfc5f40
Binary files /dev/null and b/docs/diagrams/CreateSportSequenceDiagram.png differ
diff --git a/docs/diagrams/CreateSportSequenceDiagram.puml b/docs/diagrams/CreateSportSequenceDiagram.puml
new file mode 100644
index 00000000000..03f680398fc
--- /dev/null
+++ b/docs/diagrams/CreateSportSequenceDiagram.puml
@@ -0,0 +1,83 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+title Sequence Diagram for CreateSportCommand execution
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":CreateSportCommandParser" as CreateSportCommandParser LOGIC_COLOR
+participant "d:CreateSportCommand" as CreateSportCommand LOGIC_COLOR
+participant "<> Sport" as Sport LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "m:Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("createsport s/Boxing")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("createsport s/Boxing")
+activate AddressBookParser
+
+create CreateSportCommandParser
+AddressBookParser -> CreateSportCommandParser
+activate CreateSportCommandParser
+
+CreateSportCommandParser --> AddressBookParser
+deactivate CreateSportCommandParser
+
+AddressBookParser -> CreateSportCommandParser : parse("s/Boxing")
+activate CreateSportCommandParser
+
+
+create CreateSportCommand
+CreateSportCommandParser -> CreateSportCommand : CreateSportCommand(boxing)
+activate CreateSportCommand
+
+CreateSportCommand --> CreateSportCommandParser
+deactivate CreateSportCommand
+
+CreateSportCommandParser --> AddressBookParser : d
+deactivate CreateSportCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+CreateSportCommandParser -[hidden]-> AddressBookParser
+destroy CreateSportCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+
+LogicManager -> CreateSportCommand : execute(m)
+activate CreateSportCommand
+
+CreateSportCommand -> Sport : createValidSport()
+activate Sport
+Sport --> CreateSportCommand
+deactivate Sport
+
+CreateSportCommand -> Model : getUserPrefs().getGlobalSportsListFilePath()
+activate Model
+Model --> CreateSportCommand : filePath
+deactivate Model
+
+CreateSportCommand -> Sport : saveValidSports(filePath)
+activate Sport
+Sport --> CreateSportCommand
+deactivate Sport
+
+create CommandResult
+CreateSportCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> CreateSportCommand
+deactivate CommandResult
+
+CreateSportCommand --> LogicManager : r
+deactivate CreateSportCommand
+
+[<-- LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/DeleteSequenceDiagram.png b/docs/diagrams/DeleteSequenceDiagram.png
new file mode 100644
index 00000000000..543563924ba
Binary files /dev/null and b/docs/diagrams/DeleteSequenceDiagram.png differ
diff --git a/docs/diagrams/FindSportSequenceDiagram.png b/docs/diagrams/FindSportSequenceDiagram.png
new file mode 100644
index 00000000000..987ff6d33ab
Binary files /dev/null and b/docs/diagrams/FindSportSequenceDiagram.png differ
diff --git a/docs/diagrams/FindSportSequenceDiagram.puml b/docs/diagrams/FindSportSequenceDiagram.puml
new file mode 100644
index 00000000000..edf33a5b40b
--- /dev/null
+++ b/docs/diagrams/FindSportSequenceDiagram.puml
@@ -0,0 +1,84 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":FindSportCommandParser" as FindSportCommandParser LOGIC_COLOR
+participant "<> ParserUtil" as ParserUtil LOGIC_COLOR
+participant "p:SportContainsKeywordsPredicate" as SportContainsKeywordsPredicate LOGIC_COLOR
+participant "d:FindSportCommand" as FindSportCommand LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "m:Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("findsport s/Badminton s/Soccer")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("findsport s/Badminton s/Soccer")
+activate AddressBookParser
+
+create FindSportCommandParser
+AddressBookParser -> FindSportCommandParser
+activate FindSportCommandParser
+
+FindSportCommandParser --> AddressBookParser
+deactivate FindSportCommandParser
+
+AddressBookParser -> FindSportCommandParser : parse("s/Badminton s/Soccer")
+activate FindSportCommandParser
+
+FindSportCommandParser --> ParserUtil : parseSports("Badminton, Soccer")
+activate ParserUtil
+ParserUtil --> FindSportCommandParser : sports
+deactivate ParserUtil
+
+create SportContainsKeywordsPredicate
+FindSportCommandParser -> SportContainsKeywordsPredicate : SportContainsKeywordsPredicate(sportKeywordList)
+activate SportContainsKeywordsPredicate
+
+SportContainsKeywordsPredicate --> FindSportCommandParser
+deactivate SportContainsKeywordsPredicate
+
+create FindSportCommand
+FindSportCommandParser -> FindSportCommand : FindSportCommand(p, sportKeywordList)
+activate FindSportCommand
+
+FindSportCommand --> FindSportCommandParser
+deactivate FindSportCommand
+
+FindSportCommandParser --> AddressBookParser : d
+deactivate FindSportCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+FindSportCommandParser -[hidden]-> AddressBookParser
+destroy FindSportCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+
+LogicManager -> FindSportCommand : execute(m)
+activate FindSportCommand
+
+FindSportCommand -> Model : updateFilteredPersonList(p);
+activate Model
+
+Model --> FindSportCommand
+deactivate Model
+
+create CommandResult
+FindSportCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> FindSportCommand
+deactivate CommandResult
+
+FindSportCommand --> LogicManager : r
+deactivate FindSportCommand
+
+[<-- LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/FindSportSortByDistanceDiagram.png b/docs/diagrams/FindSportSortByDistanceDiagram.png
new file mode 100644
index 00000000000..5a8998e89aa
Binary files /dev/null and b/docs/diagrams/FindSportSortByDistanceDiagram.png differ
diff --git a/docs/diagrams/FindSportSortByDistanceDiagram.puml b/docs/diagrams/FindSportSortByDistanceDiagram.puml
new file mode 100644
index 00000000000..3f69ae31140
--- /dev/null
+++ b/docs/diagrams/FindSportSortByDistanceDiagram.puml
@@ -0,0 +1,102 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":FindSportCommandParser" as FindSportCommandParser LOGIC_COLOR
+participant "<> ParserUtil" as ParserUtil LOGIC_COLOR
+participant "p:SportContainsKeywordsPredicate" as SportContainsKeywordsPredicate LOGIC_COLOR
+participant "d:FindSportSortByDistanceCommand" as FindSportSortByDistanceCommand LOGIC_COLOR
+participant "<> LocationUtil" as LocationUtil LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "m:Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("findsport pc/018906 s/Badminton s/Soccer")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("findsport pc/018906 s/Badminton s/Soccer")
+activate AddressBookParser
+
+create FindSportCommandParser
+AddressBookParser -> FindSportCommandParser
+activate FindSportCommandParser
+
+FindSportCommandParser --> AddressBookParser
+deactivate FindSportCommandParser
+
+AddressBookParser -> FindSportCommandParser : parse("pc/018906 s/Badminton s/Soccer")
+activate FindSportCommandParser
+
+FindSportCommandParser --> ParserUtil : parsePostalCode("018906")
+activate ParserUtil
+ParserUtil --> FindSportCommandParser : postalCode
+deactivate ParserUtil
+
+FindSportCommandParser --> ParserUtil : parseSports("Badminton, Soccer")
+activate ParserUtil
+ParserUtil --> FindSportCommandParser : sports
+deactivate ParserUtil
+
+create SportContainsKeywordsPredicate
+FindSportCommandParser -> SportContainsKeywordsPredicate : SportContainsKeywordsPredicate(sportKeywordList)
+activate SportContainsKeywordsPredicate
+
+SportContainsKeywordsPredicate --> FindSportCommandParser
+deactivate SportContainsKeywordsPredicate
+
+create FindSportSortByDistanceCommand
+FindSportCommandParser -> FindSportSortByDistanceCommand : FindSportSortByDistanceCommand(p, sportKeywordList, postalCode)
+activate FindSportSortByDistanceCommand
+
+FindSportSortByDistanceCommand --> LocationUtil : createLocation(tempAddress, postalCode)
+activate LocationUtil
+
+LocationUtil --> FindSportSortByDistanceCommand : location
+deactivate LocationUtil
+
+FindSportSortByDistanceCommand --> FindSportCommandParser : d
+deactivate FindSportSortByDistanceCommand
+
+FindSportCommandParser --> AddressBookParser : d
+deactivate FindSportCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+FindSportCommandParser -[hidden]-> AddressBookParser
+destroy FindSportCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+
+LogicManager -> FindSportSortByDistanceCommand : execute(m)
+activate FindSportSortByDistanceCommand
+
+FindSportSortByDistanceCommand -> Model : updateFilteredPersonList(p);
+activate Model
+
+Model --> FindSportSortByDistanceCommand
+deactivate Model
+
+FindSportSortByDistanceCommand -> Model : sortFilteredPersonList(location);
+activate Model
+
+Model --> FindSportSortByDistanceCommand
+deactivate Model
+
+create CommandResult
+FindSportSortByDistanceCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> FindSportSortByDistanceCommand
+deactivate CommandResult
+
+FindSportSortByDistanceCommand --> LogicManager : r
+deactivate FindSportSortByDistanceCommand
+
+[<-- LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/GlobalSportsListLoadSequenceDiagram.png b/docs/diagrams/GlobalSportsListLoadSequenceDiagram.png
new file mode 100644
index 00000000000..b6871841d00
Binary files /dev/null and b/docs/diagrams/GlobalSportsListLoadSequenceDiagram.png differ
diff --git a/docs/diagrams/GlobalSportsListLoadSequenceDiagram.puml b/docs/diagrams/GlobalSportsListLoadSequenceDiagram.puml
new file mode 100644
index 00000000000..9ce675b2fc6
--- /dev/null
+++ b/docs/diagrams/GlobalSportsListLoadSequenceDiagram.puml
@@ -0,0 +1,27 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+title Sequence Diagram for Loading Global Sports List
+
+' Box to indicate the Model layer (similar to your example)
+box Model MODEL_COLOR_T1
+participant ":MainApp" as MainApp MODEL_COLOR
+participant ":userPrefs" as userPrefs MODEL_COLOR
+participant "<> Sport" as sport MODEL_COLOR
+end box
+
+' MainApp gets the file path of the global sports list from userPrefs
+MainApp -> userPrefs : getGlobalSportsListFilePath()
+activate userPrefs
+userPrefs --> MainApp : filePath
+deactivate userPrefs
+
+' MainApp loads list of valid sports from json file containing the global sports list
+MainApp -> sport : loadValidSports(filePath)
+activate sport
+sport --> MainApp
+deactivate sport
+
+@enduml
+
diff --git a/docs/diagrams/LocationClassSequenceDiagram.png b/docs/diagrams/LocationClassSequenceDiagram.png
new file mode 100644
index 00000000000..393c0493489
Binary files /dev/null and b/docs/diagrams/LocationClassSequenceDiagram.png differ
diff --git a/docs/diagrams/LocationClassSequenceDiagram.puml b/docs/diagrams/LocationClassSequenceDiagram.puml
new file mode 100644
index 00000000000..818ab7d653f
--- /dev/null
+++ b/docs/diagrams/LocationClassSequenceDiagram.puml
@@ -0,0 +1,31 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+' Box to indicate the Model layer (similar to your example)
+box Model MODEL_COLOR_T1
+participant "Caller" as Caller MODEL_COLOR
+participant "loc1:Location" as loc1 MODEL_COLOR
+participant "loc2:Location" as loc2 MODEL_COLOR
+end box
+
+' Caller creates the first Location
+Caller -> loc1 : new Location("S123456", address1, 1.234, 103.456)
+activate loc1
+loc1 --> Caller
+deactivate loc1
+
+' Caller creates the second Location
+Caller -> loc2 : new Location("S654321", address2, 1.567, 103.789)
+activate loc2
+loc2 --> Caller
+deactivate loc2
+
+' Caller invokes distanceTo on the first Location, passing the second
+Caller -> loc1 : distanceTo(loc2)
+activate loc1
+loc1 -> loc1 : Calculate using Haversine formula
+loc1 --> Caller : distance in km
+deactivate loc1
+
+@enduml
diff --git a/docs/diagrams/LogicClassDiagram.png b/docs/diagrams/LogicClassDiagram.png
new file mode 100644
index 00000000000..10a95ca77b8
Binary files /dev/null and b/docs/diagrams/LogicClassDiagram.png differ
diff --git a/docs/diagrams/ModelClassDiagram.png b/docs/diagrams/ModelClassDiagram.png
new file mode 100644
index 00000000000..2d53dd35ccf
Binary files /dev/null and b/docs/diagrams/ModelClassDiagram.png differ
diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
index 0de5673070d..c7382c5fa7e 100644
--- a/docs/diagrams/ModelClassDiagram.puml
+++ b/docs/diagrams/ModelClassDiagram.puml
@@ -5,22 +5,30 @@ skinparam arrowColor MODEL_COLOR
skinparam classBackgroundColor MODEL_COLOR
Package Model as ModelPackage <>{
-Class "<>\nReadOnlyAddressBook" as ReadOnlyAddressBook
-Class "<>\nReadOnlyUserPrefs" as ReadOnlyUserPrefs
-Class "<>\nModel" as Model
-Class AddressBook
-Class ModelManager
-Class UserPrefs
-
-Class UniquePersonList
-Class Person
-Class Address
-Class Email
-Class Name
-Class Phone
-Class Tag
-
-Class I #FFFFFF
+
+ Class "<>\nReadOnlyAddressBook" as ReadOnlyAddressBook
+ Class "<>\nReadOnlyUserPrefs" as ReadOnlyUserPrefs
+ Class "<>\nModel" as Model
+ Class AddressBook
+ Class ModelManager
+ Class UserPrefs
+
+ Class UniquePersonList
+ Class Person
+ Class Address
+ Class Email
+ Class Name
+ Class Phone
+ Class Tag
+ Class Sport
+ Class Location
+
+ Class UniqueGameList
+ Class Game
+ Class DateTime
+ Class Location
+
+ Class I #FFFFFF
}
Class HiddenOutside #FFFFFF
@@ -31,6 +39,7 @@ AddressBook .up.|> ReadOnlyAddressBook
ModelManager .up.|> Model
Model .right.> ReadOnlyUserPrefs
Model .left.> ReadOnlyAddressBook
+
ModelManager -left-> "1" AddressBook
ModelManager -right-> "1" UserPrefs
UserPrefs .up.|> ReadOnlyUserPrefs
@@ -41,14 +50,24 @@ Person *--> Name
Person *--> Phone
Person *--> Email
Person *--> Address
+Person *--> Location
Person *--> "*" Tag
+Person *--> "*" Sport
Person -[hidden]up--> I
UniquePersonList -[hidden]right-> I
-
Name -[hidden]right-> Phone
Phone -[hidden]right-> Address
Address -[hidden]right-> Email
ModelManager --> "~* filtered" Person
+
+AddressBook *--> "1" UniqueGameList
+
+UniqueGameList --> "~* all" Game
+
+Game --> "~* all" Person
+Game --> "1" DateTime
+Game --> "1" Location
+
@enduml
diff --git a/docs/diagrams/ParserClasses.png b/docs/diagrams/ParserClasses.png
new file mode 100644
index 00000000000..d0f79532e2d
Binary files /dev/null and b/docs/diagrams/ParserClasses.png differ
diff --git a/docs/diagrams/StorageClassDiagram.png b/docs/diagrams/StorageClassDiagram.png
new file mode 100644
index 00000000000..e75fb46cb5e
Binary files /dev/null and b/docs/diagrams/StorageClassDiagram.png differ
diff --git a/docs/diagrams/StorageClassDiagram.puml b/docs/diagrams/StorageClassDiagram.puml
index a821e06458c..5d42739f609 100644
--- a/docs/diagrams/StorageClassDiagram.puml
+++ b/docs/diagrams/StorageClassDiagram.puml
@@ -20,6 +20,7 @@ Class JsonAddressBookStorage
Class JsonSerializableAddressBook
Class JsonAdaptedPerson
Class JsonAdaptedTag
+Class JsonAdaptedGame
}
}
@@ -38,6 +39,8 @@ JsonUserPrefsStorage .up.|> UserPrefsStorage
JsonAddressBookStorage .up.|> AddressBookStorage
JsonAddressBookStorage ..> JsonSerializableAddressBook
JsonSerializableAddressBook --> "*" JsonAdaptedPerson
+JsonSerializableAddressBook --> "*" JsonAdaptedGame
JsonAdaptedPerson --> "*" JsonAdaptedTag
+JsonAdaptedGame --> "*" JsonAdaptedPerson
@enduml
diff --git a/docs/diagrams/UiClassDiagram.png b/docs/diagrams/UiClassDiagram.png
new file mode 100644
index 00000000000..844e438be7d
Binary files /dev/null and b/docs/diagrams/UiClassDiagram.png differ
diff --git a/docs/diagrams/UiClassDiagram.puml b/docs/diagrams/UiClassDiagram.puml
index 95473d5aa19..f7848ada334 100644
--- a/docs/diagrams/UiClassDiagram.puml
+++ b/docs/diagrams/UiClassDiagram.puml
@@ -13,6 +13,9 @@ Class HelpWindow
Class ResultDisplay
Class PersonListPanel
Class PersonCard
+Class GameListPanel
+Class GameCard
+Class SportsListPanel
Class StatusBarFooter
Class CommandBox
}
@@ -33,10 +36,13 @@ UiManager -down-> "1" MainWindow
MainWindow *-down-> "1" CommandBox
MainWindow *-down-> "1" ResultDisplay
MainWindow *-down-> "1" PersonListPanel
+MainWindow *-down-> "1" GameListPanel
+MainWindow *-down-> "1" SportsListPanel
MainWindow *-down-> "1" StatusBarFooter
MainWindow --> "0..1" HelpWindow
PersonListPanel -down-> "*" PersonCard
+GameListPanel -down-> "*" GameCard
MainWindow -left-|> UiPart
@@ -44,10 +50,14 @@ ResultDisplay --|> UiPart
CommandBox --|> UiPart
PersonListPanel --|> UiPart
PersonCard --|> UiPart
+GameListPanel --|> UiPart
+GameCard --|> UiPart
+SportsListPanel --|> UiPart
StatusBarFooter --|> UiPart
HelpWindow --|> UiPart
PersonCard ..> Model
+GameCard ..> Model
UiManager -right-> Logic
MainWindow -left-> Logic
diff --git a/docs/diagrams/UndoRedoState0.png b/docs/diagrams/UndoRedoState0.png
new file mode 100644
index 00000000000..5039bf0c8a6
Binary files /dev/null and b/docs/diagrams/UndoRedoState0.png differ
diff --git a/docs/diagrams/UndoRedoState1.png b/docs/diagrams/UndoRedoState1.png
new file mode 100644
index 00000000000..9f5f1c58aec
Binary files /dev/null and b/docs/diagrams/UndoRedoState1.png differ
diff --git a/docs/diagrams/UndoRedoState2.png b/docs/diagrams/UndoRedoState2.png
new file mode 100644
index 00000000000..72dbbc8ef00
Binary files /dev/null and b/docs/diagrams/UndoRedoState2.png differ
diff --git a/docs/diagrams/UndoRedoState3.png b/docs/diagrams/UndoRedoState3.png
new file mode 100644
index 00000000000..2415daf0fff
Binary files /dev/null and b/docs/diagrams/UndoRedoState3.png differ
diff --git a/docs/diagrams/UndoRedoState4.png b/docs/diagrams/UndoRedoState4.png
new file mode 100644
index 00000000000..e008e514ab0
Binary files /dev/null and b/docs/diagrams/UndoRedoState4.png differ
diff --git a/docs/diagrams/UndoRedoState5.png b/docs/diagrams/UndoRedoState5.png
new file mode 100644
index 00000000000..e2153835729
Binary files /dev/null and b/docs/diagrams/UndoRedoState5.png differ
diff --git a/docs/diagrams/UndoSequenceDiagram-Logic.png b/docs/diagrams/UndoSequenceDiagram-Logic.png
new file mode 100644
index 00000000000..364be909d8a
Binary files /dev/null and b/docs/diagrams/UndoSequenceDiagram-Logic.png differ
diff --git a/docs/diagrams/UndoSequenceDiagram-Model.png b/docs/diagrams/UndoSequenceDiagram-Model.png
new file mode 100644
index 00000000000..6c34ddd224a
Binary files /dev/null and b/docs/diagrams/UndoSequenceDiagram-Model.png differ
diff --git a/docs/images/Ui.png b/docs/images/Ui.png
index 5bd77847aa2..035fe1537c9 100644
Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ
diff --git a/docs/images/add_command.png b/docs/images/add_command.png
new file mode 100644
index 00000000000..029331b4ab3
Binary files /dev/null and b/docs/images/add_command.png differ
diff --git a/docs/images/addgame_command.png b/docs/images/addgame_command.png
new file mode 100644
index 00000000000..9ad2f676e58
Binary files /dev/null and b/docs/images/addgame_command.png differ
diff --git a/docs/images/addmember_command.png b/docs/images/addmember_command.png
new file mode 100644
index 00000000000..a0b84524fd7
Binary files /dev/null and b/docs/images/addmember_command.png differ
diff --git a/docs/images/addsport_command.png b/docs/images/addsport_command.png
new file mode 100644
index 00000000000..0a8356fba4c
Binary files /dev/null and b/docs/images/addsport_command.png differ
diff --git a/docs/images/clear_command.png b/docs/images/clear_command.png
new file mode 100644
index 00000000000..4c7bb8d6cc2
Binary files /dev/null and b/docs/images/clear_command.png differ
diff --git a/docs/images/createsport_command.png b/docs/images/createsport_command.png
new file mode 100644
index 00000000000..93e1587b787
Binary files /dev/null and b/docs/images/createsport_command.png differ
diff --git a/docs/images/darhh.png b/docs/images/darhh.png
new file mode 100644
index 00000000000..c0e9c0cd14f
Binary files /dev/null and b/docs/images/darhh.png differ
diff --git a/docs/images/delete_command.png b/docs/images/delete_command.png
new file mode 100644
index 00000000000..58b16b7fe2c
Binary files /dev/null and b/docs/images/delete_command.png differ
diff --git a/docs/images/deletegame_command.png b/docs/images/deletegame_command.png
new file mode 100644
index 00000000000..9f729ab3384
Binary files /dev/null and b/docs/images/deletegame_command.png differ
diff --git a/docs/images/deletemember_command.png b/docs/images/deletemember_command.png
new file mode 100644
index 00000000000..4f6072ca8bd
Binary files /dev/null and b/docs/images/deletemember_command.png differ
diff --git a/docs/images/deletesport_command.png b/docs/images/deletesport_command.png
new file mode 100644
index 00000000000..846d4dd2482
Binary files /dev/null and b/docs/images/deletesport_command.png differ
diff --git a/docs/images/deletesport_global_command.png b/docs/images/deletesport_global_command.png
new file mode 100644
index 00000000000..a7a6d6aff74
Binary files /dev/null and b/docs/images/deletesport_global_command.png differ
diff --git a/docs/images/edit_command.png b/docs/images/edit_command.png
new file mode 100644
index 00000000000..632f8a5ea9f
Binary files /dev/null and b/docs/images/edit_command.png differ
diff --git a/docs/images/editgamelocation_command.png b/docs/images/editgamelocation_command.png
new file mode 100644
index 00000000000..594a260d959
Binary files /dev/null and b/docs/images/editgamelocation_command.png differ
diff --git a/docs/images/find_command.png b/docs/images/find_command.png
new file mode 100644
index 00000000000..34c55236ef6
Binary files /dev/null and b/docs/images/find_command.png differ
diff --git a/docs/images/findsport_command.png b/docs/images/findsport_command.png
new file mode 100644
index 00000000000..76a07ad0064
Binary files /dev/null and b/docs/images/findsport_command.png differ
diff --git a/docs/images/findsport_location_command.png b/docs/images/findsport_location_command.png
new file mode 100644
index 00000000000..ccabd2eb2a5
Binary files /dev/null and b/docs/images/findsport_location_command.png differ
diff --git a/docs/images/fitfriends_logo.png b/docs/images/fitfriends_logo.png
new file mode 100644
index 00000000000..e9af6dbfdcf
Binary files /dev/null and b/docs/images/fitfriends_logo.png differ
diff --git a/docs/images/gohlucas.png b/docs/images/gohlucas.png
new file mode 100644
index 00000000000..23737495fa4
Binary files /dev/null and b/docs/images/gohlucas.png differ
diff --git a/docs/images/help_command.png b/docs/images/help_command.png
new file mode 100644
index 00000000000..84be2abbff6
Binary files /dev/null and b/docs/images/help_command.png differ
diff --git a/docs/images/interface.png b/docs/images/interface.png
new file mode 100644
index 00000000000..3453b84da62
Binary files /dev/null and b/docs/images/interface.png differ
diff --git a/docs/images/isaacchua0309.png b/docs/images/isaacchua0309.png
new file mode 100644
index 00000000000..5760f0fe2cb
Binary files /dev/null and b/docs/images/isaacchua0309.png differ
diff --git a/docs/images/list_command.png b/docs/images/list_command.png
new file mode 100644
index 00000000000..57f38bf85fc
Binary files /dev/null and b/docs/images/list_command.png differ
diff --git a/docs/images/listsports_command.png b/docs/images/listsports_command.png
new file mode 100644
index 00000000000..aef97f1d469
Binary files /dev/null and b/docs/images/listsports_command.png differ
diff --git a/docs/images/main_ui.png b/docs/images/main_ui.png
new file mode 100644
index 00000000000..e793c31dee1
Binary files /dev/null and b/docs/images/main_ui.png differ
diff --git a/docs/images/main_ui_dark.png b/docs/images/main_ui_dark.png
new file mode 100644
index 00000000000..e1b61a90637
Binary files /dev/null and b/docs/images/main_ui_dark.png differ
diff --git a/docs/images/main_ui_light.png b/docs/images/main_ui_light.png
new file mode 100644
index 00000000000..46cae15a322
Binary files /dev/null and b/docs/images/main_ui_light.png differ
diff --git a/docs/images/noahang.png b/docs/images/noahang.png
new file mode 100644
index 00000000000..f5bfc9c427f
Binary files /dev/null and b/docs/images/noahang.png differ
diff --git a/docs/images/somneelsaha2004.png b/docs/images/somneelsaha2004.png
new file mode 100644
index 00000000000..153357c17ea
Binary files /dev/null and b/docs/images/somneelsaha2004.png differ
diff --git a/docs/index.md b/docs/index.md
index 7601dbaad0d..b94cdeb759d 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,19 +1,8 @@
---
layout: page
-title: AddressBook Level-3
+title: FitFriends
---
+# FitFriends
+#### [User Guide](UserGuide.md) | [Developer Guide](DeveloperGuide.md)
+**FitFriends is a desktop application designed to help you easily organize sports games with your contacts at convenient locations.** Optimized for use via a Command Line Interface (CLI) while providing a user-friendly Graphical User Interface (GUI), FitFriends enables quick and efficient scheduling of sports activities with friends.
-[](https://github.com/se-edu/addressbook-level3/actions)
-[](https://codecov.io/gh/se-edu/addressbook-level3)
-
-
-
-**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
-
-* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
-* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
-
-
-**Acknowledgements**
-
-* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
diff --git a/docs/team/darhh.md b/docs/team/darhh.md
new file mode 100644
index 00000000000..63bc7306ca5
--- /dev/null
+++ b/docs/team/darhh.md
@@ -0,0 +1,46 @@
+---
+layout: page
+title: Darren's Project Portfolio Page
+---
+
+### Project: AddressBook Level 3
+
+AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+
+Given below are my contributions to the project.
+
+* **New Feature**: Added the ability to undo/redo previous commands.
+ * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
+ * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
+ * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
+ * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*
+
+* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
+
+* **Code contributed**: [RepoSense link]()
+
+* **Project management**:
+ * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
+
+* **Enhancements to existing features**:
+ * Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
+ * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())
+
+* **Documentation**:
+ * User Guide:
+ * Added documentation for the features `delete` and `find` [\#72]()
+ * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
+ * Developer Guide:
+ * Added implementation details of the `delete` feature.
+
+* **Community**:
+ * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
+ * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
+ * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
+ * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())
+
+* **Tools**:
+ * Integrated a third party library (Natty) to the project ([\#42]())
+ * Integrated a new Github plugin (CircleCI) to the team repo
+
+* _{you can add/remove categories in the list above}_
diff --git a/docs/team/gohlucas.md b/docs/team/gohlucas.md
new file mode 100644
index 00000000000..7c64566499c
--- /dev/null
+++ b/docs/team/gohlucas.md
@@ -0,0 +1,56 @@
+---
+layout: page
+title: Lucas' Project Portfolio Page
+---
+
+### Project: FitFriends
+
+Fitfriends is a desktop address book application where the user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 12 kLoC.
+
+Given below are my contributions to the project.
+
+- **New Feature**: Added the ability to add sports to a contact.
+
+ - What it does: allows the user add sports to a contact one or more at a time.
+ - Justification: This is a core feature of the product as it is a sports based address book.
+ - Credits: _reused idea from the tags field present in address book 3._
+
+- **New Feature**: Added the ability to find contacts by sport.
+
+ - What it does: allows the user to find contacts by sport in addition to the existing find by name command.
+ - Justification: This feature logically makes sense to include as our address book is sports based.
+ - Credits: _reused idea from the find command present in address book 3._
+
+- **New Feature**: Added the view functionality for sports in a contact.
+
+ - What it does: allows the user to view the sports added to a contact.
+ - Justification: This feature improves the product significantly because a user can see what sports each of their contact plays.
+ - Credits: _reused idea by adapting attributes into .fxml files such as PersonListCard.fxml and PersonListPanel.fxml from address book 3_
+
+- **New Feature**: Added the view functionality for games.
+
+ - What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
+ - Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
+ - Credits: _reused idea from the existing .fxml files such as PersonListCard.fxml and PersonListPanel.fxml from address book 3_
+
+- **New Feature**: Added the ability to delete games.
+
+ - What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
+ - Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
+ - Credits: _{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}_
+
+- **Code contributed**: [RepoSense link](https://nus-cs2103-ay2425s2.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2025-02-21&tabOpen=true&tabType=authorship&tabAuthor=gohlucas&tabRepo=AY2425S2-CS2103T-F12-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
+
+- **Enhancements to existing features**:
+
+ - Updated the GUI to allow tags, sports and members to be displayed neatly (Pull requests [\#95]())
+
+- **Documentation**:
+
+ - User Guide:
+ - Added documentation for the features `addmember` and `deletemember` [\#244]()
+ - Developer Guide:
+ - Added User Stories and Use Cases
+
+- **Community**:
+ - PRs reviewed (with non-trivial review comments): [\#130]()
diff --git a/docs/team/isaacchua0309.md b/docs/team/isaacchua0309.md
new file mode 100644
index 00000000000..6a85868c9f3
--- /dev/null
+++ b/docs/team/isaacchua0309.md
@@ -0,0 +1,36 @@
+---
+layout: page
+title: Isaac Chua's Project Portfolio Page
+---
+
+### Project: AddressBook Level 3
+
+AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+
+Given below are my contributions to the project.
+
+* **New Feature**: Added the HelloCommand feature.
+ * What it does: Allows the user to use the "hello" command to receive a greeting from the application.
+ * Justification: This feature provides a simple way for users to test if the application is responsive and functioning correctly.
+ * Highlights: This enhancement required understanding of the command pattern used in AB3, including how to create a new command class, update the parser, and add tests.
+
+* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2425s2.github.io/tp-dashboard/#breakdown=true&search=isaacchua0309)
+
+* **Testing**:
+ * Wrote comprehensive tests for the HelloCommand feature
+ * Improved test coverage by adding tests for AddressBookParser's handling of the HelloCommand
+
+* **Documentation**:
+ * User Guide:
+ * Added documentation for the HelloCommand feature
+ * Developer Guide:
+ * Added implementation details of the HelloCommand feature
+
+* **Community**:
+ * Reported bugs and provided suggestions for other teams in the class
+
+* **Tools**:
+ * Set up and integrated testing frameworks to ensure code quality
+
+* **Project management**:
+ * Managed project tasks on GitHub issue tracker
diff --git a/docs/team/noahang.md b/docs/team/noahang.md
new file mode 100644
index 00000000000..b88e432a95e
--- /dev/null
+++ b/docs/team/noahang.md
@@ -0,0 +1,46 @@
+---
+layout: page
+title: Noah Ang's Project Portfolio Page
+---
+
+### Project: AddressBook Level 3
+
+AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+
+Given below are my contributions to the project.
+
+* **New Feature**: Added the ability to undo/redo previous commands.
+ * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
+ * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
+ * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
+ * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*
+
+* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
+
+* **Code contributed**: [RepoSense link]()
+
+* **Project management**:
+ * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
+
+* **Enhancements to existing features**:
+ * Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
+ * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())
+
+* **Documentation**:
+ * User Guide:
+ * Added documentation for the features `delete` and `find` [\#72]()
+ * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
+ * Developer Guide:
+ * Added implementation details of the `delete` feature.
+
+* **Community**:
+ * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
+ * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
+ * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
+ * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())
+
+* **Tools**:
+ * Integrated a third party library (Natty) to the project ([\#42]())
+ * Integrated a new Github plugin (CircleCI) to the team repo
+
+* _{you can add/remove categories in the list above}_
diff --git a/docs/team/somneelsaha2004.md b/docs/team/somneelsaha2004.md
new file mode 100644
index 00000000000..bca97bdaa16
--- /dev/null
+++ b/docs/team/somneelsaha2004.md
@@ -0,0 +1,46 @@
+---
+layout: page
+title: Somneel's Project Portfolio Page
+---
+
+### Project: AddressBook Level 3
+
+AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+
+Given below are my contributions to the project.
+
+* **New Feature**: Added the ability to undo/redo previous commands.
+ * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
+ * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
+ * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
+ * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*
+
+* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
+
+* **Code contributed**: [RepoSense link]()
+
+* **Project management**:
+ * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
+
+* **Enhancements to existing features**:
+ * Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
+ * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())
+
+* **Documentation**:
+ * User Guide:
+ * Added documentation for the features `delete` and `find` [\#72]()
+ * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
+ * Developer Guide:
+ * Added implementation details of the `delete` feature.
+
+* **Community**:
+ * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
+ * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
+ * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
+ * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())
+
+* **Tools**:
+ * Integrated a third party library (Natty) to the project ([\#42]())
+ * Integrated a new Github plugin (CircleCI) to the team repo
+
+* _{you can add/remove categories in the list above}_
diff --git a/remove_singleline_comments.sh b/remove_singleline_comments.sh
new file mode 100644
index 00000000000..9f73e0c4ba2
--- /dev/null
+++ b/remove_singleline_comments.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+# This script removes single-line comments but preserves Javadoc comments
+find src -name "*.java" -type f | while read file; do
+ # Process only lines that are not in Javadoc blocks
diff --git a/src/main/java/seedu/address/AppParameters.java b/src/main/java/seedu/address/AppParameters.java
index 3d603622d4e..6c3e3e37125 100644
--- a/src/main/java/seedu/address/AppParameters.java
+++ b/src/main/java/seedu/address/AppParameters.java
@@ -50,7 +50,7 @@ public boolean equals(Object other) {
return true;
}
- // instanceof handles nulls
+
if (!(other instanceof AppParameters)) {
return false;
}
diff --git a/src/main/java/seedu/address/Main.java b/src/main/java/seedu/address/Main.java
index 9461d6da769..055d7923792 100644
--- a/src/main/java/seedu/address/Main.java
+++ b/src/main/java/seedu/address/Main.java
@@ -14,8 +14,8 @@
* Error: JavaFX runtime components are missing, and are required to run this application
*
* The reason is that MainApp extends Application. In that case, the
- * LauncherHelper will check for the javafx.graphics module to be present
- * as a named module. We don't use JavaFX via the module system so it can't
+ * LauncherHelper will check for the javafx.graphics module to be presen
+ * as a named module. We don't use JavaFX via the module system so it can'
* find the javafx.graphics module, and so the launch is aborted.
*
* By having a separate main class (Main) that doesn't extend Application
@@ -26,14 +26,14 @@ public class Main {
public static void main(String[] args) {
- // As per https://github.com/openjdk/jfx/blob/master/doc-files/release-notes-16.md
- // JavaFX 16 (or later) runtime logs a warning at startup if JavaFX classes are loaded from
- // the classpath instead of a module.
- // Our application does not use Java modules yet. Even if it did, modules are ignored when
- // packed into a FAT Jar file (as we do), which means this warning will persist even then.
- // The warning however, can be safely ignored. Thus, the following log informs
- // the user (if looking at the log output) that the said warning appearing in the log
- // can be ignored.
+
+
+
+
+
+
+
+
logger.warning("The warning about Unsupported JavaFX configuration below (if any) can be ignored.");
Application.launch(MainApp.class, args);
diff --git a/src/main/java/seedu/address/MainApp.java b/src/main/java/seedu/address/MainApp.java
index 678ddc8c218..378005f3b2d 100644
--- a/src/main/java/seedu/address/MainApp.java
+++ b/src/main/java/seedu/address/MainApp.java
@@ -1,6 +1,7 @@
package seedu.address;
import java.io.IOException;
+import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Optional;
import java.util.logging.Logger;
@@ -15,12 +16,12 @@
import seedu.address.commons.util.StringUtil;
import seedu.address.logic.Logic;
import seedu.address.logic.LogicManager;
-import seedu.address.model.AddressBook;
import seedu.address.model.Model;
import seedu.address.model.ModelManager;
import seedu.address.model.ReadOnlyAddressBook;
import seedu.address.model.ReadOnlyUserPrefs;
import seedu.address.model.UserPrefs;
+import seedu.address.model.person.Sport;
import seedu.address.model.util.SampleDataUtil;
import seedu.address.storage.AddressBookStorage;
import seedu.address.storage.JsonAddressBookStorage;
@@ -36,7 +37,7 @@
*/
public class MainApp extends Application {
- public static final Version VERSION = new Version(0, 2, 2, true);
+ public static final Version VERSION = new Version(1, 5, 0, true);
private static final Logger logger = LogsCenter.getLogger(MainApp.class);
@@ -58,6 +59,7 @@ public void init() throws Exception {
UserPrefsStorage userPrefsStorage = new JsonUserPrefsStorage(config.getUserPrefsFilePath());
UserPrefs userPrefs = initPrefs(userPrefsStorage);
AddressBookStorage addressBookStorage = new JsonAddressBookStorage(userPrefs.getAddressBookFilePath());
+ logger.info("Loaded UniquePersonList and UniqueGameList from " + userPrefs.getAddressBookFilePath());
storage = new StorageManager(addressBookStorage, userPrefsStorage);
model = initModelManager(storage, userPrefs);
@@ -65,6 +67,13 @@ public void init() throws Exception {
logic = new LogicManager(model, storage);
ui = new UiManager(logic);
+ // Load global sports list from user preferences path
+ try {
+ Sport.loadValidSports(userPrefs.getGlobalSportsListFilePath());
+ logger.info("Loaded global sports list from " + userPrefs.getGlobalSportsListFilePath());
+ } catch (IOException e) {
+ logger.warning("Error loading global sports list: " + e.getMessage());
+ }
}
/**
@@ -87,9 +96,21 @@ private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) {
} catch (DataLoadingException e) {
logger.warning("Data file at " + storage.getAddressBookFilePath() + " could not be loaded."
+ " Will be starting with an empty AddressBook.");
- initialData = new AddressBook();
+ Path filePath = storage.getAddressBookFilePath();
+ try {
+ if (Files.exists(filePath)) {
+ Files.delete(filePath);
+ } else {
+ System.out.println("File does not exist, proceeding to create a new file.");
+ }
+ Files.createFile(filePath);
+ } catch (IOException ignored) {
+ ;
+ }
+ initialData = SampleDataUtil.getSampleAddressBook();
}
+
return new ModelManager(initialData, userPrefs);
}
@@ -178,9 +199,14 @@ public void start(Stage primaryStage) {
public void stop() {
logger.info("============================ [ Stopping AddressBook ] =============================");
try {
+ // Save user preferences
storage.saveUserPrefs(model.getUserPrefs());
+
+ // Save global sports list
+ Sport.saveValidSports(model.getUserPrefs().getGlobalSportsListFilePath());
+ logger.info("Saved global sports list to " + model.getUserPrefs().getGlobalSportsListFilePath());
} catch (IOException e) {
- logger.severe("Failed to save preferences " + StringUtil.getDetails(e));
+ logger.severe("Failed to save application data: " + StringUtil.getDetails(e));
}
}
}
diff --git a/src/main/java/seedu/address/commons/core/Config.java b/src/main/java/seedu/address/commons/core/Config.java
index 485f85a5e05..65f5d0575d5 100644
--- a/src/main/java/seedu/address/commons/core/Config.java
+++ b/src/main/java/seedu/address/commons/core/Config.java
@@ -14,7 +14,7 @@ public class Config {
public static final Path DEFAULT_CONFIG_FILE = Paths.get("config.json");
- // Config values customizable through config file
+
private Level logLevel = Level.INFO;
private Path userPrefsFilePath = Paths.get("preferences.json");
@@ -40,7 +40,7 @@ public boolean equals(Object other) {
return true;
}
- // instanceof handles nulls
+
if (!(other instanceof Config)) {
return false;
}
diff --git a/src/main/java/seedu/address/commons/core/GuiSettings.java b/src/main/java/seedu/address/commons/core/GuiSettings.java
index a97a86ee8d7..75f315664fc 100644
--- a/src/main/java/seedu/address/commons/core/GuiSettings.java
+++ b/src/main/java/seedu/address/commons/core/GuiSettings.java
@@ -54,13 +54,10 @@ public boolean equals(Object other) {
if (other == this) {
return true;
}
-
- // instanceof handles nulls
- if (!(other instanceof GuiSettings)) {
+ if (!(other instanceof GuiSettings otherGuiSettings)) {
return false;
}
- GuiSettings otherGuiSettings = (GuiSettings) other;
return windowWidth == otherGuiSettings.windowWidth
&& windowHeight == otherGuiSettings.windowHeight
&& Objects.equals(windowCoordinates, otherGuiSettings.windowCoordinates);
diff --git a/src/main/java/seedu/address/commons/core/LogsCenter.java b/src/main/java/seedu/address/commons/core/LogsCenter.java
index 8cf8e15a0f0..404f29522d8 100644
--- a/src/main/java/seedu/address/commons/core/LogsCenter.java
+++ b/src/main/java/seedu/address/commons/core/LogsCenter.java
@@ -19,13 +19,13 @@
*/
public class LogsCenter {
private static final int MAX_FILE_COUNT = 5;
- private static final int MAX_FILE_SIZE_IN_BYTES = (int) (Math.pow(2, 20) * 5); // 5MB
+ private static final int MAX_FILE_SIZE_IN_BYTES = (int) (Math.pow(2, 20) * 5);
private static final String LOG_FILE = "addressbook.log";
- private static final Logger logger; // logger for this class
- private static Logger baseLogger; // to be used as the parent of all other loggers created by this class.
+ private static final Logger logger;
+ private static Logger baseLogger;
private static Level currentLogLevel = Level.INFO;
- // This static block ensures essential loggers are created early
+
static {
setBaseLogger();
logger = LogsCenter.getLogger(LogsCenter.class);
@@ -38,7 +38,7 @@ public class LogsCenter {
public static void init(Config config) {
currentLogLevel = config.getLogLevel();
logger.info("Log level will be set as: " + currentLogLevel);
- // set the level of the baseLogger which will be inherited by other loggers
+
baseLogger.setLevel(currentLogLevel);
}
@@ -48,10 +48,10 @@ public static void init(Config config) {
* as the {@code baseLogger}.
*/
public static Logger getLogger(String name) {
- // Java organizes loggers into a hierarchy based on their names (using '.' as a separator, similar to how Java
- // packages form a hierarchy). Furthermore, loggers without a level inherit the level of their parent logger.
- // By prefixing names of all loggers with baseLogger's name + ".", we make the baseLogger the parent of all
- // loggers. This allows us to change the level of all loggers simply by changing the baseLogger level.
+
+
+
+
Logger logger = Logger.getLogger(baseLogger.getName() + "." + name);
removeHandlers(logger);
logger.setUseParentHandlers(true);
@@ -83,15 +83,15 @@ private static void setBaseLogger() {
baseLogger.setUseParentHandlers(false);
removeHandlers(baseLogger);
- // Level.ALL is used as the level for the handlers because the baseLogger filters the log messages by level
- // already; there is no need to control log message level of the handlers.
- // add a ConsoleHandler to log to the console
+
+
+
ConsoleHandler consoleHandler = new ConsoleHandler();
consoleHandler.setLevel(Level.ALL);
baseLogger.addHandler(consoleHandler);
- // add a FileHandler to log to a file
+
try {
FileHandler fileHandler = new FileHandler(LOG_FILE, MAX_FILE_SIZE_IN_BYTES, MAX_FILE_COUNT, true);
fileHandler.setFormatter(new SimpleFormatter());
diff --git a/src/main/java/seedu/address/commons/core/Version.java b/src/main/java/seedu/address/commons/core/Version.java
index 491d24559b4..f87443cc5a4 100644
--- a/src/main/java/seedu/address/commons/core/Version.java
+++ b/src/main/java/seedu/address/commons/core/Version.java
@@ -51,7 +51,7 @@ public boolean isEarlyAccess() {
/**
* Parses a version number string in the format V1.2.3.
* @param versionString version number string
- * @return a Version object
+ * @return a Version objec
*/
@JsonCreator
public static Version fromString(String versionString) throws IllegalArgumentException {
@@ -98,7 +98,7 @@ public boolean equals(Object other) {
return true;
}
- // instanceof handles nulls
+
if (!(other instanceof Version)) {
return false;
}
diff --git a/src/main/java/seedu/address/commons/core/index/Index.java b/src/main/java/seedu/address/commons/core/index/Index.java
index dd170d8b68d..76469bf72d2 100644
--- a/src/main/java/seedu/address/commons/core/index/Index.java
+++ b/src/main/java/seedu/address/commons/core/index/Index.java
@@ -5,8 +5,8 @@
/**
* Represents a zero-based or one-based index.
*
- * {@code Index} should be used right from the start (when parsing in a new user input), so that if the current
- * component wants to communicate with another component, it can send an {@code Index} to avoid having to know what
+ * {@code Index} should be used right from the start (when parsing in a new user input), so that if the curren
+ * component wants to communicate with another component, it can send an {@code Index} to avoid having to know wha
* base the other component is using for its index. However, after receiving the {@code Index}, that component can
* convert it back to an int if the index will not be passed to a different component again.
*/
@@ -53,7 +53,7 @@ public boolean equals(Object other) {
return true;
}
- // instanceof handles nulls
+
if (!(other instanceof Index)) {
return false;
}
diff --git a/src/main/java/seedu/address/commons/util/LocationUtil.java b/src/main/java/seedu/address/commons/util/LocationUtil.java
new file mode 100644
index 00000000000..ef82d280d33
--- /dev/null
+++ b/src/main/java/seedu/address/commons/util/LocationUtil.java
@@ -0,0 +1,145 @@
+package seedu.address.commons.util;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardCopyOption;
+import java.util.HashMap;
+import java.util.Map;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import seedu.address.commons.exceptions.DataLoadingException;
+import seedu.address.model.person.Address;
+import seedu.address.model.person.Location;
+
+
+/**
+ * A factory class to create {@code Location} objects using user input and a JSON file
+ * mapping postal codes to location data.
+ *
@@ -138,7 +182,7 @@ The `Model` component, **API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java) -
+
The `Storage` component,
* can save both address book data and user preference data in JSON format, and read them back into corresponding objects.
@@ -155,93 +199,82 @@ Classes used by multiple components are in the `seedu.address.commons` package.
This section describes some noteworthy details on how certain features are implemented.
-### \[Proposed\] Undo/redo feature
-
-#### Proposed Implementation
-
-The proposed undo/redo mechanism is facilitated by `VersionedAddressBook`. It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`. Additionally, it implements the following operations:
-
-* `VersionedAddressBook#commit()` — Saves the current address book state in its history.
-* `VersionedAddressBook#undo()` — Restores the previous address book state from its history.
-* `VersionedAddressBook#redo()` — Restores a previously undone address book state from its history.
-
-These operations are exposed in the `Model` interface as `Model#commitAddressBook()`, `Model#undoAddressBook()` and `Model#redoAddressBook()` respectively.
-
-Given below is an example usage scenario and how the undo/redo mechanism behaves at each step.
-
-Step 1. The user launches the application for the first time. The `VersionedAddressBook` will be initialized with the initial address book state, and the `currentStatePointer` pointing to that single address book state.
-
-
-
-Step 2. The user executes `delete 5` command to delete the 5th person in the address book. The `delete` command calls `Model#commitAddressBook()`, causing the modified state of the address book after the `delete 5` command executes to be saved in the `addressBookStateList`, and the `currentStatePointer` is shifted to the newly inserted address book state.
+### Game Creation feature
+The `addgame` command creates and adds a new `Game` object into the addressbook. Each `Game` object has 4 attributes: `Sport`, `LocalDateTime`, `Location` and `UniquePersonList` which are specified using the prefixes g/, dt/, pc respectively with their corresponding values. As a `Game` object is initialised without any participants at first, the `UniquePersonList` field is not mutable during initialisation and thus not included in the command.
-
+#### Implementation
+The `Game` object is added into a `UniqueGameList` object whenever `addgame` command is called. This mirrors the `Person` object and `UniquePersonList` object interaction very closely. These are shown on the User Interface via fxml code. Subsequently, the writing to and reading from the addressbook.json which stores the data is facilitated using JsonAdaptedGame and JsonAdaptedPerson which helps to convert the information to and from json readable format.
-Step 3. The user executes `add n/David …` to add a new person. The `add` command also calls `Model#commitAddressBook()`, causing another modified address book state to be saved into the `addressBookStateList`.
+### Game Deletion feature
+Similar to `addgame` feature
-
+### Global Sports List Management feature
-:information_source: **Note:** If a command fails its execution, it will not call `Model#commitAddressBook()`, so the address book state will not be saved into the `addressBookStateList`.
+#### Overview
-
-
-Step 4. The user now decides that adding the person was a mistake, and decides to undo that action by executing the `undo` command. The `undo` command will call `Model#undoAddressBook()`, which will shift the `currentStatePointer` once to the left, pointing it to the previous address book state, and restores the address book to that state.
+The Global Sports List Management feature allows users to manage a central repository of valid sports that can be assigned to contacts. This feature enhances the sports functionality of the application by providing a consistent set of sports across all contacts.
-
+#### Implementation
-:information_source: **Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather
-than attempting to perform the undo.
+The implementation includes several components:
-
+1. **Valid sport tracking**: The `Sport` class maintains a static set of valid sports and provide methods for manipulating this set.
-The following sequence diagram shows how an undo operation goes through the `Logic` component:
+2. **UserPrefs integration**: The global sports list's file path is stored in `UserPrefs`, allowing the path to be persisted and retrieved across application sessions.
-
+3. **File storage**: The global sports list is saved to and loaded from a JSON file, ensuring persistence between application runs.
-:information_source: **Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
-
-
+4. **Command implementation**: Three new commands (`CreateSportCommand`, `ListSportsCommand`, and `DeleteSportCommand`) have been implemented to manage the global sports list.
-Similarly, how an undo operation goes through the `Model` component is shown below:
+Here's an overview of how the feature works:
-
+
-The `redo` command does the opposite — it calls `Model#redoAddressBook()`, which shifts the `currentStatePointer` once to the right, pointing to the previously undone state, and restores the address book to that state.
+
-:information_source: **Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest address book state, then there are no undone AddressBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
+1. On application startup, the `MainApp` class loads the global sports list from the file path specified in `UserPrefs`.
+2. When a user adds a new sport using `CreateSportCommand`, the sport is added to the valid sports list in the `Sport` class and saved to the file.
+3. The `ListSportsCommand` displays all available sports in alphabetical order with indices.
+4. The `DeleteSportCommand` removes a sport from the global list by its index in the alphabetically sorted list.
+5. When the application is closed, the global sports list is saved to ensure persistence.
-
-
-Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitAddressBook()`, `Model#undoAddressBook()` or `Model#redoAddressBook()`. Thus, the `addressBookStateList` remains unchanged.
+#### Design considerations:
-
+**Aspect: Storage of global sports list**
-Step 6. The user executes `clear`, which calls `Model#commitAddressBook()`. Since the `currentStatePointer` is not pointing at the end of the `addressBookStateList`, all address book states after the `currentStatePointer` will be purged. Reason: It no longer makes sense to redo the `add n/David …` command. This is the behavior that most modern desktop applications follow.
+* **Alternative 1 (current choice):** Store the sports list in a separate JSON file.
+ * Pros: Separation of concerns, easier to manage and update independent of contacts.
+ * Cons: Requires additional file I/O operations.
-
+* **Alternative 2:** Store the sports list as part of the UserPrefs.
+ * Pros: Single file for all user preferences, potentially simpler implementation.
+ * Cons: Bloats the UserPrefs object, especially as the sports list grows.
-The following activity diagram summarizes what happens when a user executes a new command:
+**Aspect: Management of sports list**
-
+* **Alternative 1 (current choice):** Use a static set in the Sport class.
+ * Pros: Easy to access from anywhere in the codebase, consistent validation.
+ * Cons: Static state can be more difficult to test.
-#### Design considerations:
+* **Alternative 2:** Store in Model as a field.
+ * Pros: Follows the architectural pattern more closely, easier to test.
+ * Cons: Requires passing the model to more components, potentially complicating the design.
-**Aspect: How undo & redo executes:**
+**Aspect: Command structure for deleting sports**
-* **Alternative 1 (current choice):** Saves the entire address book.
- * Pros: Easy to implement.
- * Cons: May have performance issues in terms of memory usage.
+* **Alternative 1 (current choice):** Have two separate usages for `deletesport` command (with and without sport name).
+ * Pros: Intuitive naming, as both commands deal with deleting sports.
+ * Cons: Could cause confusion due to the dual behavior.
-* **Alternative 2:** Individual command knows how to undo/redo by
- itself.
- * Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
- * Cons: We must ensure that the implementation of each individual command are correct.
+* **Alternative 2:** Use separate commands like `deleteglobalsport` and `deletepersonsport`.
+ * Pros: Clear distinction between different operations.
+ * Cons: More commands to learn, potentially less intuitive naming.
-_{more aspects and alternatives to be added}_
+#### Future enhancements:
-### \[Proposed\] Data archiving
-
-_{Explain here how the data archiving feature will be implemented}_
+* **Categorization**: Group sports by type (e.g., team sports, individual sports).
+* **Popularity tracking**: Track which sports are most commonly used across contacts.
+* **Sport details**: Add additional information like required equipment or typical venue types.
--------------------------------------------------------------------------------------------------------------------
@@ -263,34 +296,51 @@ _{Explain here how the data archiving feature will be implemented}_
**Target user profile**:
* has a need to manage a significant number of contacts
+* has a need for frequent sporting activities with friends
* prefer desktop apps over other types
* can type fast
* prefers typing to mouse interactions
* is reasonably comfortable using CLI apps
**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
+so as to reduce the hassle when organizing sports meetups.
### User stories
Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
-| Priority | As a … | I want to … | So that I can… |
-| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- |
-| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App |
-| `* * *` | user | add a new person | |
-| `* * *` | user | delete a person | remove entries that I no longer need |
-| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list |
-| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident |
-| `*` | user with many persons in the address book | sort persons by name | locate a person easily |
-
-*{More to be added}*
+| Priority | As a … | I want to … | So that I can… |
+|----------|---------------------------------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
+| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App |
+| `* * *` | user | add a new person | so that I can store their information |
+| `* * *` | user | delete a person | remove entries that I no longer need |
+| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list |
+| `* * *` | sporty person | add a person's preferred sport | know who to arrange games with when I want to play a certain sport |
+| `* * *` | sporty person | add a friend's contact number | contact them to meet up for games in future |
+| `* * *` | user looking to pick up a new sport | find friends by sport played | invite them to play or teach me the sport |
+| `* * *` | network enthusiast | see where my contacts live | meet up with them more easily |
+| `* * *` | impromptu person | see where my friends live | see which friends are in the area when I am out and suddenly want to catch up |
+| `* * *` | caring friend | see what sports my friends play | arrange a session when I have something to talk about/check on them |
+| `* *` | sporty person | find sports facilities near me | play sports there |
+| `* *` | user | hide private contact details | protect the contact details of persons in my address book |
+| `* *` | student | receive suggested sports venues based on my group's location | arrange a meetup location which is fair and convenient |
+| `* *` | user who prefers structured planning | book facilities directly through the app | reduce the hassle of navigating multiple booking applications |
+| `* *` | busy professional | quickly check for the nearest sports facility before heading down | save time |
+| `* *` | user who dislikes long commutes | set a maximum travel distance to be used to filter out addresses that are too far away from my location | receive suggestions from the application which fall within my preferred range |
+| `* *` | user | be able to edit an existing contact | update their contact details |
+| `* *` | working professional | add my favourite sports venues | quickly suggest them for meetups |
+| `* *` | thrifty user | be able to filter results only to show free to use facilities | enjoy sports without paying for private courts |
+| `* *` | tennis player | be reminded to bring my racket | save the trouble of having to borrow a racket at the last minute |
+| `* *` | sporty person | set my friend's preferred play locations | know where to meet them for games |
+| `* *` | working adult | tag contacts with custom labels | categorize them by friends/work |
+| `* *` | sports coach | track where my students live | organize training sessions at convenient locations |
### Use cases
(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise)
-**Use case: Delete a person**
+**Use case 1: Delete a person**
**MSS**
@@ -298,35 +348,100 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
2. AddressBook shows a list of persons
3. User requests to delete a specific person in the list
4. AddressBook deletes the person
+ Use case ends.
+ **Extensions**
+* 2a. The list is empty.
+ Use case ends.
+* 3a. The given index is invalid.
+ * 3a1. AddressBook shows an error message.
+
+ Use case resumes at step 2.
+
+**Use case 2: Tag a contact**
+
+**MSS**
+
+1. User requests to list persons
+2. AddressBook shows a list of persons
+3. User requests to tag a specific person in the list
+4. AddressBook updates the person's contact details
Use case ends.
-**Extensions**
+ **Extensions**
* 2a. The list is empty.
Use case ends.
-* 3a. The given index is invalid.
+* 3a. The person is not in the list.
+
+ * 3a1. AddressBook shows an error message.
+
+ Use case resumes at step 2.
+
+**Use case 3: Filter by location**
- * 3a1. AddressBook shows an error message.
+**MSS**
+
+1. User requests to list persons
+2. AddressBook shows a list of persons
+3. User enters a location to filter the list
+4. AddressBook updates the list shown to user
+
+ Use case ends.
+
+ **Extensions**
+
+* 2a. The list is empty.
- Use case resumes at step 2.
+ Use case ends.
+
+* 3a. The given location is invalid.
+
+ * 3a1. AddressBook shows an error message.
+
+ Use case resumes at step 2.
+
+* 4a. The given location does not belong to any user.
-*{More to be added}*
+ * 4a1. AddressBook shows an error message.
+
+ Use case resumes at step 2.
+
+**Use case 4: Edit a contact**
+
+**MSS**
+
+1. User searches for a person
+2. AddressBook shows matching result(s)
+3. User requests to view contact details
+4. AddressBook shows contact details
+5. User selects field to update details
+6. AddressBook reflects updated contact details
+
+ Use case ends.
+
+ **Extensions**
+
+* 2a. The list is empty.
+
+ Use case ends.
### Non-Functional Requirements
1. Should work on any _mainstream OS_ as long as it has Java `17` or above installed.
2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
3. 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.
-
-*{More to be added}*
+4. The system must be designed for a single user only, user data is private and not shared between different users.
+5. Users should be able to run the application from a single executable JAR file.
+6. The system must automatically save data after each user edit to ensure data persistence.
### Glossary
* **Mainstream OS**: Windows, Linux, Unix, MacOS
* **Private contact detail**: A contact detail that is not meant to be shared with others
+* **JAR File**: A compressed package that bundles Java classes, resources metadata into a single executable file
--------------------------------------------------------------------------------------------------------------------
@@ -334,49 +449,242 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
Given below are instructions to test the app manually.
-:information_source: **Note:** These instructions only provide a starting point for testers to work on;
+**Note:** These instructions only provide a starting point for testers to work on;
testers are expected to do more *exploratory* testing.
-
-
### Launch and shutdown
1. Initial launch
- 1. Download the jar file and copy into an empty folder
+2. Download the jar file and copy into an empty folder.
+
+3. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
+
+4. Saving window preferences.
+
+5. Resize the window to an optimum size. Move the window to a different location. Close the window.
+
+6. Re-launch the app by double-clicking the jar file.+ Expected: The most recent window size and location is retained. However, if the window was closed in light mode, it will start in dark mode as we chose to reduce the glare when the application is booted up. + +### Adding a person + +#### Adding a person to contact list - 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. +1. Prerequisites: None. -1. Saving window preferences +2. Test case: `add n/John Doe p/98765432 e/johnd@example.com a/John Street, #01-01 t/bestfriend s/tennis pc/402001`
+ Expected: John Doe contact is added to the list. Details of the contact shown in the status message. PersonCard is found in the list on the left. - 1. Resize the window to an optimum size. Move the window to a different location. Close the window. +3. Test case: `add n/John Doe p/98765432 e/johnd@example.com a/John Street, #01-01 t/bestfriend s/tennis pc/123456`
+ Expected: No person is added due to invalid postal code. Error details shown in the status message. - 1. Re-launch the app by double-clicking the jar file.
- Expected: The most recent window size and location is retained. +4. Other incorrect add commands to try:
+ `add n/John Doe p/ e/johnd@example.com a/John Street, #01-01 s/tennis pc/402001`,
+ `add n/John Doe p/98765432 e/johnd@example.com a/, #01-01 s/tennis pc/402001`, `...`
+ Expected: Similar to previous. -1. _{ more test cases … }_ +### Editing a person + +#### Editing a person while at least one person is being shown + +1. Prerequisites: List all persons using the `list` command or List persons using the 'find' command. At least 1 person in the list. + +2. Test case: `edit 1 n/Alicia Tay`
+ Expected: First contact has name edited to \"Alicia Tay\". Details of the outcome of the edit shown in the status message. + +3. Test case: `edit 1 n/`
+ Expected: No name is edited due to erroneous name field. Details of the error shown in the status message. + +4. Other incorrect edit commands to try: `edit`, `edit x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. ### Deleting a person -1. Deleting a person while all persons are being shown +#### Deleting a person while all persons are being shown + +1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. + +2. Test case: `delete 1`
+ Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + +3. Test case: `delete 0`
+ Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. + +4. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Creating a sport in the global list + +#### Creating a sport + +1. Prerequisites: None. + +2. Test case: `createsport s/archery`
+ Expected: Archery will be created in the global list. Details of the outcome of the createsport shown in the status message. + +3. Other incorrect createsport commands to try: `createsport`, `...`
+ Expected: Similar to previous. + +### Listing global sports + +#### Lists all global sports. + +1. Prerequisites: None + +2. Test case: `listsports`
+ Expected: Lists all registered sports in the status message. + +3. Other incorrect listsports commands to try: `listsports 1`, `deletesport abc`, `...`
+ Expected: Similar to previous. + +### Deleting a sport from global list + +#### Deleting a sport from list of registered sports + +1. Prerequisites: At least 1 sport in the global list. + +2. Test case: `deletesport 1`
+ Expected: The first sport in the list, if it exists, is deleted. Details of the outcome of the deletesport shown in the status message. + +3. Test case: `deletesport 0`
+ Expected: No sport is deleted due to invalid index. Details of the outcome of the deletesport shown in the status message. + +4. Other incorrect deletesport commands to try: `deletesport`, `deletesport x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Adding a sport to a person + +#### Adding a sport to a person while at least one person is being shown + +1. Prerequisites: List all persons using the `list` command or List persons using the 'find' command. At least 1 person in the list. + +2. Test case: `addsport 1 s/basketball`
+ Expected: First contact has basketball added to its registered sports, unless the sport already exists in their contact. Details of the outcome of the addsport shown in the status message. + +3. Test case: `addsport 1 s/chocolate`
+ Expected: No sport is added due to invalid sport. Details of the outcome of the addsport shown in the status message. + +4. Test case: `addsport 0 s/basketball`
+ Expected: No sport is added due to invalid index. Details of the outcome of the addsport shown in the status message. + +5. Other incorrect addsport commands to try: `addsport`, `addsport x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + + +### Deleting a sport from a person + +#### Deleting a sport from a person while at least one person is being shown + +1. Prerequisites: List all persons using the `list` command or List persons using the 'find' command. At least 1 person in the list. + +2. Test case: `deletesport 1 s/basketball`
+ Expected: First contact has basketball deleted from its registered sports, if the sport already exists in their contact. Details of the outcome of the deletesport shown in the status message. + +3. Test case: `deletesport 1 s/chocolate`
+ Expected: No sport is deleted due to invalid sport. Details of the outcome of the deletesport shown in the status message. + +4. Test case: `deletesport 0 s/basketball`
+ Expected: No sport is added due to invalid index. Details of the outcome of the deletesport shown in the status message. + +6. Other incorrect deletesport commands to try: `deletesport`, `deletesport x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Finding persons who play specific sports + +#### Displaying a list of person who play specific sports + +1. Prerequisites: At least one person must play one of the sports in the list of sports provided. + +2. Test case: `findsport s/basketball`
+ Expected: Contacts who have basketball in their registered sports will be shown. Details of the outcome of the findsport shown in the status message. + +3. Test case: `findsport s/chocolate`
+ Expected: Error message is shown as sport is not one of the registered sports. Details of the outcome of the findsport shown in the status message. + +4. Other incorrect findsport commands to try: `findsport`, `findsport all`, `...`
+ Expected: Similar to previous. + +### Finding persons who play a particular sport near a location + +#### Displaying a list of person who play specific sports + +1. Prerequisites: At least one person must play one of the sports in the list of sports provided. Postal Code must be valid. + +2. Test case: `findsport pc/402001 s/basketball`
+ Expected: Contacts who have basketball in their registered sports will be shown by ascending order of distance from the specified location. Details of the outcome of the findsport shown in the status message. + +3. Test case: `findsport pc/123456 s/tennis`
+ Expected: Error message is shown as postal code is not valid. Details of the outcome of the findsport shown in the status message. + +4. Test case: `findsport pc/402001 s/chocolate`
+ Expected: Error message is shown as sport is not in registered list of sports. Details of the outcome of the findsport shown in the status message. + +5. Other incorrect findsport commands to try: `findsport`, `findsport all`, `...`
+ Expected: Similar to previous. + +### Adding a game + +#### Adds a game to the gamelist + +1. Prerequisites: Game must be a registered sport. Date time must follow specified format. Postal Code must be valid. + +2. Test case: `addgame g/volleyball dt/2025-04-04T15:00:00 pc/402001`
+ Expected: Game will be added and the details of the game will be shown in the status message of addgame. + +3. Test case: `addgame g/tennis`
+ Expected: Error message is shown as date time and postal code not added. Details of the outcome of the addgame shown in the status message. + +4. Other incorrect addgame commands to try: `addgame`, `addgame g/chocolate`, `...`
+ Expected: Similar to previous. + +### Deleting a game + +#### Deletes a game from gamelist + +1. Prerequisites: At least one game must exist. + +2. Test case: `deletegame 1`
+ Expected: Game at index 1 will be deleted. Details of the outcome of the deletegame shown in the status message. + +3. Test case: `deletegame 0`
+ Expected: Error message is shown as postal index is not valid. Details of the outcome of the deletegame shown in the status message. + +4. Other incorrect deletegame commands to try: `deletegame`, `deletegame x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Adding a member to a game + +#### Adds a member to a game in the gamelist + +1. Prerequisites: At least one game must exist. The member must exist in the person list. + +2. Test case: `addmember g/1 n/Alice Pauline`
+ Expected: \"Alice Pauline\" will be added to game at index 1. Details of the outcome of the addmember shown in the status message. + +3. Test case: `addmember g/0 n/Alice Pauline`
+ Expected: Error message is shown as index is not valid. Details of the outcome of the addmember shown in the status message. - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. +4. Test case: `addmember g/1 n/Banana Man`
+ Expected: Error message is shown as contact is not in the person list. Details of the outcome of the addmember shown in the status message. - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. +5. Other incorrect addmember commands to try: `addmember g/1`, `addmember all`, `...`
+ Expected: Similar to previous. - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. +### Deleting a member from game - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. +#### Delets a member from a game in the gamelist -1. _{ more test cases … }_ +1. Prerequisites: At least one game must exist in the gamelist. Member must exist in the person list. -### Saving data +2. Test case: `deletemember g/1 n/Alice Pauline`
+ Expected: \"Alice Pauline\" will be deleted from game at index 1. Details of the outcome of the deletemember shown in the status message. -1. Dealing with missing/corrupted data files +3. Test case: `deletemember g/0 n/Alice Pauline`
+ Expected: Error message is shown as index is not valid. Details of the outcome of the deletemember shown in the status message. - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ +4. Test case: `deletemember g/1 n/Banana Man`
+ Expected: Error message is shown as contact is not in the person list. Details of the outcome of the deletemember shown in the status message. -1. _{ more test cases … }_ +5. Other incorrect deletemember commands to try: `deletemember g/1`, `deletemember all`, `...`
+ Expected: Similar to previous. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..ffe06c405c2 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,26 @@ +# FitFriends Theme Documentation +This site is built using GitHub Pages with Jekyll. + +## Theme Information + +This site uses the `jekyll-theme-primer` theme, which is one of the supported themes for GitHub Pages. + +## Troubleshooting Theme Issues + +If you encounter theme-related build errors: + +1. Ensure that the theme specified in `_config.yml` matches the theme actually used by GitHub Pages +2. Make sure `docs/assets/css/style.scss` imports stylesheets that are compatible with the chosen theme +3. If using custom styles, make sure they don't conflict with the theme + +## Local Development + +To test this documentation site locally: + +1. Install Ruby and Bundler +2. Navigate to the `docs` directory +3. Run `bundle install` to install dependencies +4. Run `bundle exec jekyll serve` to start a local server +5. Visit `http://localhost:4000` to view the site + +For more information, see the [GitHub Pages documentation](https://docs.github.com/en/pages). diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 27c2d1cf16c..23bd9124a3d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1,200 +1,579 @@ --- layout: page -title: User Guide +title: FitFriends User Guide --- +# FitFriends User Guide +*Last Updated: 7 Apr 2025* -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, 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, AB3 can get your contact management tasks done faster than traditional GUI apps. +
-* Table of Contents
-{:toc}
+## 🏆 Our Mission
---------------------------------------------------------------------------------------------------------------------
+FitFriends is designed to help **sporty young adults** connect, organize and participate in sports activities together. In today's busy world, finding friends with similar sporting interests and coordinating meetups can be challenging. FitFriends makes this process seamless and enjoyable.
-## Quick start
+*refers to adults between 16-35 years of age and are active or looking to get active in the sporting scene
-1. Ensure you have Java `17` or above installed in your Computer.- **Mac users:** Ensure you have the precise JDK version prescribed [here](https://se-education.org/guides/tutorials/javaInstallationMac.html). +### 🎯 Problems We're Solving -1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases). +**Primary Challenge:** +- Difficulty in organizing sports meetups with friends who share similar interests in specific locations -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. +**Secondary Challenges:** +- Remembering which friends play which sports +- Finding suitable locations for sports activities based on everyone's location +- Discovering conversation topics related to sports interests -1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.
- A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
-  +### 💪 How FitFriends Helps You -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: +- **Sports-focused contact management:** Keep track of which friends play which sports +- **Location-based planning:** Sort friends by proximity to a specific location using postal codes +- **Game organization:** Create games for different sports or friend circles +- **Smart recommendations:** Find the perfect sports partners based on interests and location - * `list` : Lists all contacts. +> 📊 **Did you know?** According to our surveys, 78% of young adults want to try new sports but don't know who to play with. FitFriends helps you discover which friends might be interested in picking up new sports like tennis or pickleball together! - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. +--- + +## 📋 Table of Contents + + +- ️️Getting Started + - [System Requirements](#system-requirements) + - [Installation](#installation) + - [First Launch](#first-launch) +- ️️Using FitFriends + - [Interface Overview](#interface-overview) + - [Command Format](#command-format) +- ️️Basic Features + - [Viewing Help](#viewing-help) + - [Managing Contacts](#managing-contacts) + - [Sports Management](#sports-management) + - [Game Management](#game-management) +- Command Summary +- ️️Faqs +- ️️Troubleshooting +- ️️References + + +--- + +## 💻 Getting Started + +### System Requirements + +- **Operating System:** Windows 10/11, macOS 10.15+, or Linux +- **Java:** Version 17 or above ([Download here](https://www.oracle.com/java/technologies/downloads/)) +- **Storage:** Minimum 100MB free space +- **RAM:** Minimum 2GB (4GB recommended) + +### Installation + +1. **Download** the latest `FitFriends.jar` file from our [releases page](https://github.com/AY2425S2-CS2103T-F12-1/tp/releases). + +2. **Create a folder** where you want to store FitFriends data. + +3. **Move** the downloaded `.jar` file to this folder. + +### First Launch + +#### Using the Command Line Interface (CLI) +###### Learn more about CLI [here](https://www.techtarget.com/searchwindowsserver/definition/command-line-interface-CLI). + +1. **Open a terminal/command prompt** + - Windows: `Win + R` > type `cmd` + - macOS: `Cmd + Space` > type `terminal` + - Linux: `Ctrl + Alt + T` + +2. **Navigate to folder**: + ``` + cd path/to/your/fitfriends/folder + ``` + +3. **Launch the application**: + ``` + java -jar FitFriends.jar + ``` + +4. **You should see** the FitFriends interface. Congratulations! You're ready to start. + +#### Using the Graphical Interface + +1. **Double-click** on the FitFriends.jar file. + + > ⚠️ **If this doesn't work**: Your system might not have associated .jar files with Java. Use the CLI method above or right-click the file and select "Open with Java". + +2. **You should see** the FitFriends interface. Congratulations! You're ready to start. + +--- +## 🏋️️ Using FitFriends +### Interface Overview + +FitFriends combines the power of a Command Line Interface (CLI) with the convenience of a Graphical User Interface (GUI): + +- **Command Box**: Type your commands here and press Enter to execute +- **Result Display**: Shows the result of your command +- **Friend List**: Displays all your contacts with their information +- **Person Card**: Shows detailed information for each contact + +**Before you start**, we suggest: +> 💡 **Tip**: Expand the size of the GUI window by clicking on and dragging the sides outwards, which we have done in our examples below. + +> 💡 **Tip**: Switch to light and dark mode by clicking on the button at the top right of the interface. + + + + +### Command Format + +- Words in `UPPERCASE` are parameters to be supplied by you. +- Items in square brackets `[...]` are optional. +- Items with `...` after them can have multiple instances. +- Parameters can be in any order. + +> ⚠️ **Note**: Command words are case-sensitive, so you should only type `help`, and not `HELP`, `HeLp` or even `Help`. + +--- +## 🌟 Basic Features + +### Viewing Help + +Need assistance? The help command gives you quick access to instructions. + +**Format**: +``` +help +``` + +When you type `help` and press Enter, you'll see a pop-up that looks like this: + + + + +--- + +## Managing Contacts + +### Add Contact + +Add contacts to your FitFriends list with details that help plan sporting activities. + +**Format**: +``` +add n/NAME p/PHONE e/EMAIL a/ADDRESS [t/TAG] s/SPORT pc/POSTALCODE +``` + +**Example**: +``` +add n/John Doe p/98765432 e/johnd@example.com a/John Street, #01-01 t/bestfriend s/tennis pc/119077 +``` + +This adds John Doe to your list of contacts with his details and shows he plays tennis: + + + +> ⚠️ **Notes**: +> * Name: Names are case-insensitive (e.g., the names, Somneel and somneel, are the same and will not be allowed when adding a contact). +> * Adding a contact places them in the alphabetically sorted position in the list. +> * "s/o" will not be accepted as part of a name, we recommend you enter this part of your contact's name as "s_o", "so" or even "s o" instead. +> * Postal Code: Only valid Singapore postal codes are accepted. +> * Sport: Only valid sports from "Valid Sports List" are allowed. You can add valid sports to this list by using the `createsport` command. +> * Tag: Tags are optional. You can add as many tags as you want to a contact (e.g., `t/bestfriend t/colleague`). Tags help you categorize your contacts. + +### List All Contacts + +View all your contacts in one place. + +**Format**: +``` +list +``` + +This displays all your contacts in the left panel, sorted by alphabetical order: + + + +> ⚠️ **Notes**: +> * You should run this command after adding, deleting or editing contacts to see the updated list. +> * You should also run this command after running find or findsport commands to view the full list. + +### Edit Contact + +Update your contact's details as they change. + +**Format**: +``` +edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG] [pc/POSTALCODE] +``` - * `delete 3` : Deletes the 3rd contact shown in the current list. +**Example**: +``` +edit 2 n/James Lee p/87654321 a/45 Sunset Blvd pc/119077 +``` - * `clear` : Deletes all contacts. +This updates the 2nd contact in your current FitFriends list with a new name, phone number, address, and postal code: - * `exit` : Exits the app. + -1. Refer to the [Features](#features) below for details of each command. +> ⚠️ **Notes**: +> * Editing a tag will remove all existing tags as tags cannot be added sequentially (e.g., `edit t/bestfriend` followed by `edit t/colleague` will result in only the `colleague` tag remaining). +> * Adding a contact automatically places them in the alphabetically sorted position in the list. +> * "s/o" will not be accepted as part of a name, we recommend you enter this part of your contact's name as "s_o", "so" or even "s o" instead. --------------------------------------------------------------------------------------------------------------------- +### Find Contacts by Name -## Features +Quickly find contacts by searching for part of their name. -
+**Format**:
+```
+find KEYWORD [MORE_KEYWORDS]
+```
-**:information_source: Notes about the command format:**
+**Example**: +``` +find james jake +``` -* 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`. +This will show all contacts whose names contain "James" or "Jake": -* 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. +> ⚠️ **Notes**: +> - Search keywords are case-insensitive +> - Order of keywords doesn't matter +> - Only full words are matched (e.g., "Han" won't match "Hans") +> - Any contact matching at least one keyword will be shown +> - If you run edit, delete, addsport, deletesport commands immediately after this command, these commands will apply to the contact listed at the index as shown by the find command. Use this to manage your contacts without having to search for them manually! -* 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. -* 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`. +### Delete Contact -* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. -
+Remove contacts from your FitFriends list.
-### Viewing help : `help`
+**Format**:
+```
+delete INDEX
+```
-Shows a message explaning how to access the help page.
+**Example**:
+```
+delete 3
+```
-
+This removes the 3rd contact in your current FitFriends list:
-Format: `help`
+
+### Clear All Entries
-### Adding a person: `add`
+Start fresh by removing all contacts and games from your FitFriends list.
-Adds a person to the address book.
+**Format**:
+```
+clear
+```
-Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
+> ⚠️ **Warning**: This action cannot be undone. All your contacts and games will be permanently removed.
-+**Example**: +``` +find james jake +``` -* 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`. +This will show all contacts whose names contain "James" or "Jake": -* 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. +> ⚠️ **Notes**: +> - Search keywords are case-insensitive +> - Order of keywords doesn't matter +> - Only full words are matched (e.g., "Han" won't match "Hans") +> - Any contact matching at least one keyword will be shown +> - If you run edit, delete, addsport, deletesport commands immediately after this command, these commands will apply to the contact listed at the index as shown by the find command. Use this to manage your contacts without having to search for them manually! -* 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. -* 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`. +### Delete Contact -* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. -
:bulb: **Tip:**
-A person can have any number of tags (including 0)
-
+
-Examples:
-* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
-* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal`
+---
+
+## Sports Management
+
+### Add new Sport to Global List of Sports
+Add new sports to the global sports list that can be added to your contacts.
+
+**Format**:
+```
+createsport s/SPORT_NAME
+```
+
+**Example**:
+```
+createsport s/archery
+```
+
+This adds archery to the global sports list that can be assigned to your contacts:
+
+
+
+> ⚠️ **Note**: Sport names entered in commands are case-insensitive and will be stored and displayed in lowercase.
+
+### List All Sports
+View all available sports in the global sports list with their indices.
+
+**Format**:
+```
+listsports
+```
+
+This displays all sports in alphabetical order with numbers for reference:
+
+
+
+> ⚠️ **Note**: Take note of the indices as they're needed when deleting sports from the global list.
+
+### Delete Sport from Global List of Sports
+
+Removes sport from the global sports list.
+
+**Format**:
+```
+deletesport INDEX
+```
-### Listing all persons : `list`
+**Example**:
+```
+deletesport 1
+```
-Shows a list of all persons in the address book.
+This removes the first sport in the alphabetically sorted global sports list:
-Format: `list`
+
-### Editing a person : `edit`
+> ⚠️ **Warning**: Removing a sport from the global list means it can no longer be assigned to a contact.
-Edits an existing person in the address book.
+### Add Sport to Contact
-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
+Record which sports your contacts play to make planning activities easier.
-* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …
-* At least one of the optional fields must be provided.
-* Existing values will be updated to the input values.
-* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
-* You can remove all the person’s tags by typing `t/` without
- specifying any tags after it.
+**Format**:
+```
+addsport INDEX s/SPORT
+```
-Examples:
-* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively.
-* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
+**Example**:
+```
+addsport 2 s/basketball
+```
-### Locating persons by name: `find`
+This adds basketball to the list of sports played by the 2nd contact in your current FitFriends list:
-Finds persons whose names contain any of the given keywords.
+
-Format: `find KEYWORD [MORE_KEYWORDS]`
+> ⚠️ **Notes**:
+> * You can only add one sport at a time. For multiple sports, use the command several times.
+> * You can only add sports that exist in the global sports list.
-* The search is case-insensitive. e.g `hans` will match `Hans`
-* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
-* Only the name is searched.
-* Only full words will be matched e.g. `Han` will not match `Hans`
-* Persons matching at least one keyword will be returned (i.e. `OR` search).
- e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
+### Delete Sport from Contact
-Examples:
-* `find John` returns `john` and `John Doe`
-* `find alex david` returns `Alex Yeoh`, `David Li`-  +Update your FitFriends list if a contact no longer plays a particular sport. -### Deleting a person : `delete` +**Format**: +``` +deletesport INDEX s/SPORT +``` -Deletes the specified person from the address book. +**Example**: +``` +deletesport 2 s/basketball +``` -Format: `delete INDEX` +This removes basketball from the 2nd contact's list of played sports: -* Deletes the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, … + -Examples: -* `list` followed by `delete 2` deletes the 2nd person in the address book. -* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. +> ⚠️ **Note**: This command has the same command name as deleting a sport from the global sports list. To prevent accidental deletion of sport from global sports list, ensure you add "s/SPORT" at the end of this command to delete a sport from a contact. -### Clearing all entries : `clear` +### Find Contacts by Sport -Clears all entries from the address book. +Discover which contacts play specific sports—perfect for organizing game days! + +**Format**: +``` +findsport s/SPORT [s/SPORT] +``` + +**Example**: +``` +findsport s/basketball s/tennis +``` + +This shows all contacts who play either basketball or tennis (or both): + + + +> 💡 **Tip**: If you run edit, delete, addsport, deletesport commands immediately after this command, these commands will apply to the contact listed at the index as shown by the findsport command. Use this to manage your contacts without having to search for them manually! + +### Find Contacts by Sport and Location + +Find sports contacts near a specific location—ideal for planning convenient meetups! + +**Format**: +``` +findsport pc/POSTALCODE s/SPORT [s/SPORT] +``` + +**Example**: +``` +findsport pc/119077 s/tennis s/hockey +``` + +This shows all contacts who play tennis or hockey, sorted by their proximity to postal code 119077: + + + +> ⚠️ **Notes**: +> * Search keywords are case-insensitive +> * Proximity is calculated by contact's postal code +> * More than 1 sport can be included in the search by adding s/SPORT_NAME + +> 💡 **Tips**: +> * Use this feature to find the optimal meeting spot for your sports game! +> * If you run edit, delete, addsport, deletesport commands immediately after this command, these commands will apply to the contact listed at the index as shown by the findsport command. Use this to manage your contacts without having to search for them manually! + +--- -Format: `clear` +## Game Management -### Exiting the program : `exit` +### Add Game -Exits the program. +Organize your contacts into games for different activities or events. -Format: `exit` +**Format**: +``` +addgame g/SPORT_NAME dt/DATE_TIME pc/POSTAL_CODE +``` -### Saving the data +**Example**: +``` +addgame g/badminton dt/2025-04-01T15:00:00 pc/119077 +``` -AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +This creates a new game called "badminton": -### Editing the data file + -AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. +### Delete Game -
:exclamation: **Caution:**
-If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
-Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. -
+Remove Games you no longer need.
-### Archiving data files `[coming in v2.0]`
+**Format**:
+```
+deletegame INDEX
+```
-_Details coming soon ..._
+**Example**:
+```
+deletegame 1
+```
---------------------------------------------------------------------------------------------------------------------
+This deletes the game at index 1:
-## FAQ
+
-**Q**: How do I transfer my data to another Computer?-Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. -
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +### Add Member to Game --------------------------------------------------------------------------------------------------------------------- +Adds contacts as members to a particular game -## Known issues +**Format**: +``` +addmember g/INDEX n/PERSON_NAME +``` -1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. -2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window. +**Example**: +``` +addmember g/1 n/John Doe +``` +This adds the contact with name John Doe to game at index 1: --------------------------------------------------------------------------------------------------------------------- + -## Command summary +### Delete Member from Game + +Delete members from a particular game + +**Format**: +``` +deletemember g/INDEX n/PERSON_NAME +``` + +**Example**: +``` +deletemember g/1 n/John Doe +``` + +This deletes the contact with name John Doe from game at index 1: + + + +### Edit Location of Game + +**Format**: + +Changes the location of an existing game +``` +editgamelocation g/INDEX pc/POSTAL_CODE +``` + +**Example**: +``` +editgamelocation g/1 pc/639798 +``` + +This changes the postal code of game at index 1 to 639798: + + +--- + +## 📝 Command Summary + +| **Action** | **Format** | **Example** | +|------------------------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| **Viewing Help** | `help` | `help` | +| **Add Contact** | `add n/NAME p/PHONE e/EMAIL a/ADDRESS [t/TAG] s/SPORT pc/POSTALCODE` | `add n/John Doe p/98765432 e/johnd@example.com a/John St t/friend s/tennis pc/119077` | +| **List All Contacts** | `list` | `list` | +| **Edit Contact** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG] [pc/POSTALCODE]` | `edit 2 n/James Lee p/98765432 a/Block 123 pc/119077` | +| **Find Contacts by Name** | `find KEYWORD [MORE_KEYWORDS]` | `find James Jake` | +| **Delete Contact** | `delete INDEX` | `delete 3` | +| **Clear All Entries** | `clear` | `clear` | +| **Add new Sport to Global List of Sports** | `createsport s/SPORT_NAME` | `createsport s/archery` | +| **List All Sports** | `listsports` | `listsports` | +| **Delete Sport from Global List of Sports** | `deletesport INDEX` | `deletesport 1` | +| **Add Sport to Contact** | `addsport INDEX s/SPORT` | `addsport 1 s/tennis` | +| **Delete Sport from Contact** | `deletesport INDEX s/SPORT` | `deletesport 2 s/basketball` | +| **Find Contacts by Sport** | `findsport s/SPORT [s/SPORT]` | `findsport s/basketball s/tennis` | +| **Find Contacts by Sport and Location** | `findsport pc/POSTALCODE s/SPORT [s/SPORT]` | `findsport pc/119077 s/tennis s/hockey` | +| **Add Game** | `addgame g/SPORT_NAME dt/DATE_TIME pc/POSTAL_CODE` | `addgame g/volleyball dt/2025-04-04T15:30:00 pc/119077` | +| **Delete Game** | `deletegame INDEX` | `deletegame 1` | +| **Add Member to Game** | `addmember g/INDEX n/PERSON_NAME` | `addmember g/1 n/Alice Pauline` | +| **Delete Member from Game** | `deletemember g/INDEX n/PERSON_NAME` | `deletemember g/1 n/Alice Pauline` | +| **Edit Location of Game** | `editgamelocation g/INDEX pc/POSTAL_CODE` | `editgamelocation g/1 pc/119077` | + + + +--- +## 🙋 FAQs + +**Q: Can I use FitFriends to find sports facilities?** +A: Currently, FitFriends doesn't directly provide information about sports facilities, but it helps you coordinate with friends who live near specific locations by using findsport with postal codes. + +**Q: How many sports can I add per friend?** +A: There is no limit! Add as many sports as your friend plays. + +**Q: Can I import contacts from my phone?** +A: This feature is coming in our next update. Stay tuned! + +--- +## 🛠️ Troubleshooting + +**Problem: FitFriends won't start** +- Verify you have Java 17+ installed by running `java -version` in your terminal, if the version is correct, a message like this should appear: `java version "17.0.13" 2024-10-15 LTS` +- Try running FitFriends from the command line to see error messages and describe your problem to a generative AI model like ChatGPT. + +**Problem: Command not recognized** +- Check your spelling and format +- Refer to the Command Summary table for correct syntax + +**Still need help?** Visit our [support page](https://github.com/AY2425S2-CS2103T-F12-1/tp/issues) or email `fitfriends.support@gmail.com`. + +--- +## 📚 References + +1. [Benefits of sports in social bonding](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6125028/) +2. [The importance of location in sports participation](https://www.tandfonline.com/doi/full/10.1080/16184742.2019.1566931) +3. [Java documentation](https://docs.oracle.com/en/java/) + +--- -Action | Format, Examples ---------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**List** | `list` -**Help** | `help` +[Back to Top](#fitfriends-user-guide) diff --git a/docs/_config.yml b/docs/_config.yml index 6bd245d8f4e..048b0fc3a94 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,5 +1,5 @@ -title: "AB-3" -theme: minima +title: "FitFriends" +theme: jekyll-theme-primer header_pages: - UserGuide.md @@ -8,7 +8,7 @@ header_pages: markdown: kramdown -repository: "se-edu/addressbook-level3" +repository: "https://github.com/AY2425S2-CS2103T-F12-1/tp.git" github_icon: "images/github-icon.png" plugins: diff --git a/docs/_data/projects.yml b/docs/_data/projects.yml deleted file mode 100644 index 8f3e50cb601..00000000000 --- a/docs/_data/projects.yml +++ /dev/null @@ -1,23 +0,0 @@ -- name: "AB-1" - url: https://se-edu.github.io/addressbook-level1 - -- name: "AB-2" - url: https://se-edu.github.io/addressbook-level2 - -- name: "AB-3" - url: https://se-edu.github.io/addressbook-level3 - -- name: "AB-4" - url: https://se-edu.github.io/addressbook-level4 - -- name: "Duke" - url: https://se-edu.github.io/duke - -- name: "Collate" - url: https://se-edu.github.io/collate - -- name: "Book" - url: https://se-edu.github.io/se-book - -- name: "Resources" - url: https://se-edu.github.io/resources diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html deleted file mode 100644 index 8559a67ffad..00000000000 --- a/docs/_includes/custom-head.html +++ /dev/null @@ -1,6 +0,0 @@ -{% comment %} - Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: - - 1. Head over to https://realfavicongenerator.net/ to add your own favicons. - 2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. -{% endcomment %} diff --git a/docs/_includes/head.html b/docs/_includes/head.html deleted file mode 100644 index 83ac5326933..00000000000 --- a/docs/_includes/head.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - {%- include custom-head.html -%} - -
- {%- assign default_paths = site.pages | map: "path" -%}
- {%- assign page_paths = site.header_pages | default: default_paths -%}
- {%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
- {{ site.title | escape }}
-
- {%- if titles_size > 0 -%}
-
- {%- endif -%}
-
-{{ page.title | escape }}
-
- {{ content }}
-
-
-+ * This utility manages the creation of Location objects, which serve as the authoritative + * source for postal code information in the application. This design ensures consisten + * postal code validation and access. + *
+ * When handling postal codes, always use the methods in this class for validation
+ * and the getPostalCode() method from Location objects for retrieval.
+ */
+public class LocationUtil {
+
+
+ private static final Map
+ * Supports a minimal set of list operations, and automatically sorts the games by date/time.
+ * This ensures that game indices are consistent and predictable in commands and UI.
+ */
+public class UniqueGameList implements Iterable
+ * This class serves as the primary authority for postal code information in the application.
+ * All postal code access should be done through Location objects rather than directly.
+ *
+ * This class also provides functionality to calculate the distance between two locations.
+ */
+public class Location {
+
+ public static final String MESSAGE_CONSTRAINTS = "Postal code not found: %1$s, "
+ + "please key in a valid Singapore postal code";
+
+ private final String postalCode;
+ private final Address address;
+ private final double latitude;
+ private final double longitude;
+
+ /**
+ * Constructs a {@code Location} with the specified details.
+ *
+ * @param postalCode the postal code.
+ * @param address the full address.
+ * @param latitude the latitude coordinate.
+ * @param longitude the longitude coordinate.
+ */
+ public Location(String postalCode, Address address, double latitude, double longitude) {
+ requireAllNonNull(postalCode, address);
+ this.postalCode = postalCode;
+ this.address = address;
+ this.latitude = latitude;
+ this.longitude = longitude;
+ }
+
+ /**
+ * Returns the postal code of this location.
+ * This is the authoritative source of postal code information in the application.
+ *
+ * @return the postal code as a String
+ */
+ public String getPostalCode() {
+ return postalCode;
+ }
+
+ public Address getAddress() {
+ return address;
+ }
+
+ public double getLatitude() {
+ return latitude;
+ }
+
+ public double getLongitude() {
+ return longitude;
+ }
+
+ /**
+ * Calculates the distance between this location and another location using the Haversine formula.
+ *
+ * @param other the other location to measure the distance to.
+ * @return the distance in kilometers.
+ */
+ public double distanceTo(Location other) {
+ Objects.requireNonNull(other, "Other location cannot be null");
+ final int earthRadiusKm = 6371;
+ double dLat = Math.toRadians(other.latitude - this.latitude);
+ double dLon = Math.toRadians(other.longitude - this.longitude);
+ double a = Math.sin(dLat / 2) * Math.sin(dLat / 2)
+ + Math.cos(Math.toRadians(this.latitude))
+ * Math.cos(Math.toRadians(other.latitude))
+ * Math.sin(dLon / 2) * Math.sin(dLon / 2);
+ double c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a));
+ return earthRadiusKm * c;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (!(o instanceof Location)) {
+ return false;
+ }
+ Location location = (Location) o;
+ return Double.compare(location.latitude, latitude) == 0
+ && Double.compare(location.longitude, longitude) == 0
+ && postalCode.equals(location.postalCode)
+ && address.equals(location.address);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(postalCode, address, latitude, longitude);
+ }
+
+ @Override
+ public String toString() {
+ return String.format("Location[postalCode=%s, address=%s, latitude=%.6f, longitude=%.6f]",
+ postalCode, address, latitude, longitude);
+ }
+}
diff --git a/src/main/java/seedu/address/model/person/Name.java b/src/main/java/seedu/address/model/person/Name.java
index 173f15b9b00..541b14c6c05 100644
--- a/src/main/java/seedu/address/model/person/Name.java
+++ b/src/main/java/seedu/address/model/person/Name.java
@@ -50,7 +50,7 @@ public boolean equals(Object other) {
return true;
}
- // instanceof handles nulls
+
if (!(other instanceof Name)) {
return false;
}
diff --git a/src/main/java/seedu/address/model/person/NameContainsKeywordsPredicate.java b/src/main/java/seedu/address/model/person/NameContainsKeywordsPredicate.java
index 62d19be2977..9b8d7ef118b 100644
--- a/src/main/java/seedu/address/model/person/NameContainsKeywordsPredicate.java
+++ b/src/main/java/seedu/address/model/person/NameContainsKeywordsPredicate.java
@@ -18,6 +18,7 @@ public NameContainsKeywordsPredicate(List
examples:
* containsWordIgnoreCase("ABc def", "abc") == true
* containsWordIgnoreCase("ABc def", "DEF") == true
- * containsWordIgnoreCase("ABc def", "AB") == false //not a full word match
+ * containsWordIgnoreCase("ABc def", "AB") == false
*
* @param sentence cannot be null
* @param word cannot be null, cannot be empty, must be a single word
@@ -51,7 +51,7 @@ public static String getDetails(Throwable t) {
/**
* Returns true if {@code s} represents a non-zero unsigned integer
* e.g. 1, 2, 3, ..., {@code Integer.MAX_VALUE}
- * Will return false for any other non-null string input
+ * Will return false for any other non-null string inpu
* e.g. empty string, "-1", "0", "+1", and " 2 " (untrimmed), "3 0" (contains whitespace), "1 a" (contains letters)
* @throws NullPointerException if {@code s} is null.
*/
@@ -60,7 +60,7 @@ public static boolean isNonZeroUnsignedInteger(String s) {
try {
int value = Integer.parseInt(s);
- return value > 0 && !s.startsWith("+"); // "+1" is successfully parsed by Integer#parseInt(String)
+ return value > 0 && !s.startsWith("+");
} catch (NumberFormatException nfe) {
return false;
}
diff --git a/src/main/java/seedu/address/logic/Logic.java b/src/main/java/seedu/address/logic/Logic.java
index 92cd8fa605a..6021dbe6e21 100644
--- a/src/main/java/seedu/address/logic/Logic.java
+++ b/src/main/java/seedu/address/logic/Logic.java
@@ -8,18 +8,20 @@
import seedu.address.logic.commands.exceptions.CommandException;
import seedu.address.logic.parser.exceptions.ParseException;
import seedu.address.model.ReadOnlyAddressBook;
+import seedu.address.model.game.Game;
import seedu.address.model.person.Person;
/**
- * API of the Logic component
+ * API of the Logic component.
*/
public interface Logic {
/**
* Executes the command and returns the result.
+ *
* @param commandText The command as entered by the user.
* @return the result of the command execution.
* @throws CommandException If an error occurs during command execution.
- * @throws ParseException If an error occurs during parsing.
+ * @throws ParseException If an error occurs during parsing.
*/
CommandResult execute(String commandText) throws CommandException, ParseException;
@@ -30,9 +32,12 @@ public interface Logic {
*/
ReadOnlyAddressBook getAddressBook();
- /** Returns an unmodifiable view of the filtered list of persons */
+ /** Returns an unmodifiable view of the filtered list of persons. */
ObservableList
*