Merge pull request nus-cs2113-AY2324S1#9 from AY2324S1-CS2113-F11-3/master

Update

Author: Cheezeblokz

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.Duke
+

data/events/event.txt

@@ -1,2 +1,3 @@
 submit v1.0 | 2023-10-29T23:59:59 | 2023-10-30T23:59:59 
 eat dinner | 2023-12-20T19:00 | 2023-12-20T20:00 
+Do HW | 2023-12-20T12:30:30 | 2023-12-20T12:30:30 

data/flashcards/flashcard 1124.txt

@@ -0,0 +1 @@
+3 | Hello | Duke | - | - | -

data/flashcards/flashcard 18.50.11.txt

@@ -0,0 +1,2 @@
+2 | d | a | - | 2023-11-02T00:03:45.242754100 # MODERATE/2023-11-02T00:03:47.250188600 # EASY/2023-11-02T00:03:49.267332500 # HARD/2023-11-02T00:16:31.511531100 # MODERATE/2023-11-02T00:18:58.600168500 # MODERATE/2023-11-02T00:19:05.649443900 # MODERATE | -
+4 | Hello | Duke | - | - | -

data/flashcards/flashcard.txt

@@ -1,2 +1,2 @@
-2 | d | a | - | 2023-11-02T00:03:45.242754100 # MODERATE/2023-11-02T00:03:47.250188600 # EASY/2023-11-02T00:03:49.267332500 # HARD/2023-11-02T00:16:31.511531100 # MODERATE/2023-11-02T00:18:58.600168500 # MODERATE/2023-11-02T00:19:05.649443900 # MODERATE | -
-4 | Hello | Duke | - | - | -
+3 | cs2113 | software enginnering | 5 
+5 | Hello | Duke | 5 

docs/DeveloperGuide.md

@@ -10,22 +10,39 @@
 
 ### Storage Components
 
-API: `Storage.java`
+API: `FlashcardStorage.java`
 
-The `Storage` component,
+![Flashcard Storage Sequance Diagram](photo/FlashcardStorage-0.png)
+
+The `FlashcardStorage` component,
 * can save flashcards in `flashcard.txt` in specific text format
-* can save events in `event.txt` in specific text format
 * saves automatically when changes occur.
 * component loads automatically when the program starts.  
 * component can check if the saved txt file has been damaged.
 
+`EventStorage` has same structure.
+
+
 ### Calendar Components
-  
-The `Calendar` component,
-* Add events
-* Delete events
-* List events
-* Find events
+
+#### Command Package
+
++ The package has 7 files in it for users to command their calendar. Those files are 
+  AddEventCommand, DeleteAllEventsCommand, DeleteEventCommand, EventCommand, FindEventCommand
+  ListEventCommand, and UnknownCommand. The other 6 commands extend EventCommand, which is
+  an abstract class that forces other 6 commands to have an execute method.
+
+
++ Each command files execute its own commands. The UnknownCommand file handles the exceptions,
+  such as if the user commands something that doesn't exist
+
+#### Calendar Package
+
++ The calendar package excluding the command package has another 8 files.
+  The empty calendar class is reserved for adding future implementations.
+  The CalendarManager, EventStorage, & CalendarCommandParser manages user input, saves, and loads them.
+  The classes are associated with one another through instant accesses and other means. The 
+  CalendarManager directs the events and event list, which then are run on Duke.
 
 ## Product scope
 

docs/Diagrams/FlashcardStorage.puml

@@ -1,5 +1,61 @@
 @startuml
-activate FlashcardStorage
 
+participant ":FlashcardComponent" as fc
+participant ":FlashcardDirectory" as fd
+participant ":FlashcardStorage" as fs
+participant ":FlashcardList" as fl2
+participant ":FlashcardList" as fl
+participant ":FlashcardStorageParser" as fp
+
+
+activate fc
+
+create fd
+fc->fd ++: new
+
+return directory:FlashcardDirectory()
+
+destroy fd
+
+create fs
+fc->fs ++: FlashcardStorage(directory)
+
+return : FlashcardStorage
+
+fc->fs++ : loadFlashcards()
+
+alt default
+
+create fl
+fs->fl ++: FlashcardList()
+
+return :FlashcardList
+
+
+
+    loop for all lines in file
+
+        fs->fp++ : loadFlashcard()
+
+        return flashcard:Flashcard
+
+        fs->fl ++: add(flashcard)
+        return
+
+    end
+
+    return :FlashcardList
+
+else FileNotFoundException
+
+
+    fs-->fc
+    create fl2
+    fc->fl2 ++: FlashcardList(emptyArray)
+    return :FlashcardList
+
+
+
+end
 
 @enduml

docs/UserGuide.md

@@ -9,89 +9,106 @@ taking.
 ## Quick Start
 
 1. Ensure that you have Java 11 or above installed.
-2. Down the latest jar from [the latest release on GitHub]
-   (https://github.com/AY2324S1-CS2113-F11-3/tp/releases).
+2. Down the latest jar from [the latest release on GitHub](https://github.com/AY2324S1-CS2113-F11-3/tp/releases).
 3. Run the jar via `java -jar duke.jar`
 
-## General explanation of flashcards
-
 ## Features
 
-### Listing all flashcards: `list flashcards`
-
-Prints out a list of all flashcards.
-
-Format: `list flashcards`
-
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
-
-Format: `todo n/TODO_NAME d/DEADLINE`
+### Flashcard-related features
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.
+#### General explanation of flashcards
 
-Example of usage:
+#### Listing all flashcards: `list flashcards`
 
-`todo n/Write the rest of the User Guide d/next week`
+Prints out a list of all flashcards that shows each flashcard's front text 
+and back text as well as its id and current difficulty level.
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+Format: `list flashcards`
 
-### Creating a new flashcard: `create flashcard`
+#### Creating a new flashcard: `create flashcard`
 
 Starts the process of adding a new flashcard.
 
-After entering this command, you are prompted to first input the front page 
-text (once you have typed it out, submit it by pressing <ENTER>) and then the 
-back page text (once you have typed it out, submit it by pressing <ENTER>) of 
+After entering this command, you are prompted to first input the front page
+text (once you have typed it out, submit it by pressing <ENTER>) and then the
+back page text (once you have typed it out, submit it by pressing <ENTER>) of
 your new flashcard.
 
-After you've done this, a success message will be printed out. This 
+After you've done this, a success message will be printed out. This
 indicates that a new flashcard has been successfully created and saved.
 
 Format: `create flashcard`
 
-### Reviewing your flashcards: `review flashcards`
+#### Reviewing your flashcards: `review flashcards`
 
 Starts the process of reviewing flashcard.
 
-After entering this command, you are prompted to select your exact review 
-mode from 3 choices:
+After entering this command, you are prompted to select your exact review
+mode from two choices:
 
 - `random mode`: Randomly selects flashcards to review
-- `spaced repetition mode`: Which flashcards are shown depends on how well 
-  you previously knew them. Flashcards which you couldn't remember well are 
-  shown more often, while flashcards which you remembered well are shown 
+- `spaced repetition mode`: Which flashcards are shown depends on how well
+  you previously knew them. Flashcards which you couldn't remember well are
+  shown more often, while flashcards which you remembered well are shown
   less often.
-- `review by tag mode`: Randomly selects flashcards with a certain tag to review
 
-Input `a` to choose `random mode`, input `b` to choose `spaced repetition 
-mode` and input `c` to choose `review by tag mode`.
+Input `a` to choose `random mode`, or input `b` to choose `spaced repetition
+mode`.
 
-Once you've selected a review mode, the actual review begins: the front page 
-of a flashcard is shown to you. You should now try and think of the answer 
-(the text on the back page of the flashcard); and once you're ready, press 
+Once you've selected a review mode, the actual review begins: the front page
+of a flashcard is shown to you. You should now try and think of the answer
+(the text on the back page of the flashcard); and once you're ready, press
 <ENTER> to compare it to the actual back page.
 
+In spaced repetition mode, after you have revealed the back page of a 
+flashcard, you are prompted to rate how to difficult it was to remember. 
+Select `E` if it was easy, `M` if it was moderately hard and `H` if it was 
+quite hard. This information is used to adjust the difficulty of the 
+flashcard you just reviewed.
+
 Now, the process repeats and the next flashcard is shown to you.
 
-If you want to quit the review process, simply input `q` or `quit` instead 
+If you want to quit the review process, simply input `q` or `quit` instead
 of pressing <ENTER> to reveal the back page.
 
 Format: `create flashcard`
 
-## General explanation of calendar features
+#### Deleting a flashcard
 
-## Features
-- `add event` , `delete event`
-- `list events` , `find event`
-- `delete all events`
+Starts the process of deleting a flashcard.
 
-### Add an Event to the Calendar: `add event`
+After entering this command, you are prompted to input the id of the 
+flashcard you want to delete. Input it into the terminal and then press enter.
 
-- **Adds an event to the calendar with start and end time** 
+If it was a valid id, the flashcard with that id is deleted; otherwise, an 
+error message is shown and you are prompted to retry.
 
-Format: `add event`
+Format: `delete flashcard`
+
+#### Deleting all flashcards: `delete all flashcards`
+
+Deletes all flashcards that you have added so far.
+
+Format: `delete all flashcards`
+
+
+
+
+### General Explanation of Calendar Features
+
+Here is your features list:
+
++ `add event` , `delete event`
++ `list events` , `find event`
++ `delete all events`
+
+Users can use the above features to handle their events
+
+#### Adding a todo: `todo`
+
+Adds a new item to the list of todo items.
+
+Format: `todo n/TODO_NAME d/DEADLINE`
 
 * The `DEADLINE` can be in a natural language format.
 * The `TODO_NAME` cannot contain punctuation.
@@ -102,6 +119,78 @@ Example of usage:
 
 `todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
 
+
+
+#### Add an Event to the Calendar
+
+**Adds an event to the calendar with start and end time** 
+
+#### Usage
+
++ Format: `add event` [Command]
++ What's the event?: `Event name` [Event name]
++ When does it start?: `yyyy-mm-ddThh:mm:ss` [Start time]
++ When does it end?: `yyyy-mm-ddThh:mm:ss` [End time]
+
+**Example of usage**:
+
++ `Enter your command: add event`
++ `What's the event?: Do HW`
++ `When does it start?: 2023-12-20T12:30:30`
++ `When does it end?: 2023-12-20T12:40:30`
+
+#### Delete an Event From the Calendar
+
+**deletes an event from the calendar with event name**
+
+#### Usage
+
++ Format: `delete event` 
++ Enter the event name: `Event name` [Event name]
+
+**Example of usage**:
+
++ `Enter your command: delete event`
++ `Enter the event name: Do HW`
+
+#### Delete All Events From the Calendar
+
+**deletes all events from the calendar**
+
+#### Usage
+
++ Format: `delete all events`
+
+**Example of usage**:
+
++ `Enter your command: delete all events`
+
+#### Find an Event From the Calendar
+
+**finds an event from the calendar**
+
+##### Usage
+
++ Format: `find event`
++ What event are you looking for?: `event name`
+
+**Example of usage**:
+
++ `Enter your command: find event`
++ `What event are you looking for?: Do HW`
+
+#### List All Events From the Calendar
+
+**Lists all events from the calendar**
+
+#### Usage
+
++ Format: `list events`
+
+**Example of usage**:
+
++ `Enter your command: find event`
+
 ## FAQ
 
 **Q**: Where can I find my flashcard and caldendar data?
@@ -119,3 +208,8 @@ Every event and flashcard are automatically save after each command.
 * List all flashcards: `list flashcards`
 * Create a new flashcard: `create flashcard`
 * Review your flashcards: `review flashcards`
+* Create an event: `add event`
+* Delete an event: `delete event`
+* Delete all events: `delete all events`
+* Find an event: `find event`
+* List events: `list events`