[CS2113-W13-3] EventManagerCLI

.github/workflows/gradle.yml

@@ -30,6 +30,18 @@ jobs:
           java-version: '17'
           java-package: jdk+fx
 
+      - name: Install dos2unix (Ubuntu)
+        if: runner.os == 'Linux'
+        run: sudo apt-get install -y dos2unix
+
+      - name: Install dos2unix (MacOS)
+        if: runner.os == 'macOS'
+        run: brew install dos2unix
+
+      - name: Install dos2unix (Windows)
+        if: runner.os == 'Windows'
+        run: choco install dos2unix
+
       - name: Build and check with Gradle
         run: ./gradlew check
 
@@ -47,4 +59,4 @@ jobs:
         if: always() && runner.os == 'Windows'
         working-directory:  ${{ github.workspace }}/text-ui-test
         shell: cmd
-        run: runtest.bat
+        run: runtest.bat

.gitignore

@@ -15,3 +15,4 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+src/main/java/META-INF/MANIFEST.MF

README.md

@@ -1,6 +1,6 @@
-# Duke project template
+# EventManagerCLI
 
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
+This is a project template for a greenfield Java project. It's named after the Java mascot EventManagerCLI. Given below are instructions on how to use it.
 
 ## Setting up in Intellij
 

build.gradle

@@ -29,7 +29,7 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.manager.Main")
 }
 
 shadowJar {
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+Display |       Name       | Github Profile | Portfolio 
+--------|:----------------:|:--------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) | Liang Kuan Hsien | [Github](https://github.com/KuanHsienn) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Lim Tze Kang | [Github](https://github.com/LTK-1606) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Glenn Chew | [Github](https://github.com/glenn-chew) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Jeremy Goh | [Github](https://github.com/jemehgoh) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | FU Yixuan | [Github](https://github.com/MatchaRRR) | [Portfolio](docs/team/yixuan.md)

docs/DeveloperGuide.md

@@ -4,26 +4,83 @@
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
+## Design
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+<img src = "images/ArchitectureDiagram.png">
+
+The *Architecture Diagram* given above provides the high-level design of the application.
+
+### Main components
+
+The application comprises the following components:
+* `Main`, which handles program startup and shutdown, and also interactions between other components.
+* `UI`, which handles user input and showing messages to the user.
+* `Storage`, which handles the loading and saving of data upon program startup and shutdown.
+* `Parser`, which converts user input into commands.
+* `Command`, which are executed to modify the data stored in the program.
+* `EventList`, which stores the program's data.
+
+### Interactions between components
+
+<img src = "images/ArchitectureSequenceDiagram.png">
+
+The above *Sequence Diagram* shows how the different components of the system interact with one
+another in the scenario when the command `add -e event -t 1200 -v venue` is executed.
+
+
+## Implementation
+
+This section describes some noteworthy details on how certain features are implemented.
+
+### List feature[TBD]
+
+The `list` feature allows users to view all scheduled events in the system. 
+It is implemented in the `ListCommand` class, which extends the base `Command` class and formats the output to display all events. 
+Internally, the `list` operation does not modify any data but simply retrieves and displays the information from `EventList`.
+
+The `ListCommand` class performs the following key operations:
+
+* ListCommand#execute() — Generates a formatted message displaying all events in the list.
+
+These operations are accessible through the `Command` and can be invoked when the list command is entered by the user.
+
+Given below is an example usage scenario and the behavior of the list feature at each step:
+
+1. User Command Input:
+The user enters the command `list` to view all scheduled events.
+
+2. Command Recognition:
+The `COMMAND_WORD` is set to "list", enabling the system to recognize the command input and invoke `ListCommand`.
+
+3. Execution of ListCommand#execute():
+The `execute()` method retrieves each event from `eventList` and appends it to a formatted output message.
+It uses the `String.format` method with `LIST_MESSAGE` to include the total number of events in the message header.
+Events are appended to `outputMessage` with numbered formatting for readability.
+
+4. Output Generation:
+The method stores the generated `outputMessage` in `this.message`, ready for display.
 
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+The target user:
+* has a need to organise a large number of events
+* organises small-scale events, such that he is able to handle all matters on his own
+* prefers typing to mouse interactions
+* is comfortable using a command-line interface
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+The user is able to organise and manage his events more quickly and efficiently than with a mouse/GUI app
 
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+| Version | As a ... | I want to ...            | So that I can ...                                      |
+|---------|----------|--------------------------|--------------------------------------------------------|
+| v1.0    | new user | see usage instructions   | refer to them when I forget how to use the application |
+| v2.0    | user     | mark events as completed | easily track all past events                           |
+| v2.0    | user     | mark participants present| know exactly who signed up but did not attend the event|
 
 ## Non-Functional Requirements
 

docs/UserGuide.md

@@ -2,41 +2,86 @@
 
 ## Introduction
 
-{Give a product intro}
+EventManager CLI is a CLI application that allows organisers of small-scale events to track
+the participants and logistics of such events.
 
 ## Quick Start
 
-{Give steps to get started quickly}
-
 1. Ensure that you have Java 17 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+2. Down the latest version of `EventManagerCLI` from [here](https://github.com/AY2425S1-CS2113-W13-3/tp/releases).
+3. Open a new terminal in the folder that you put the JAR file in, and run the program with the  
+command ```java -jar EventManagerCLI.jar```.
+The following message would be printed:
+```
+Welcome to EventManagerCLI.
+Enter a command:
+```
 
 ## Features 
 
-{Give detailed description of each feature}
+### Viewing the command list: `menu`
+Shows a list of all valid user commands in the program.
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+```
+Here are the possible commands:
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+add -e EVENT -t TIME -v VENUE: Add an event to the event list.
+list: List events.
+remove -e EVENT: Remove an event from the event list.
+add -p PARTICIPANT -e EVENT: Add a participant to an event.
+view -e EVENT: View the list of participants of an event.
+remove -p PARTICIPANT -e EVENT: Remove a participant from an event.
+```
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+Format: `menu`
 
-Example of usage: 
+### List all events: `list`
+Shows a list of all events currently stored in the program.
 
-`todo n/Write the rest of the User Guide d/next week`
+Format: `list`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+### Add an event or participant: `add`
+Adds an event to the event list, or a participant to an event.
 
-## FAQ
+Format:  
+* `add -e EVENT -t TIME -v VENUE` for adding an event to the events list.
+* `add -p PARTICIPANT -e EVENT` for adding a participant to an event.
 
-**Q**: How do I transfer my data to another computer? 
+Examples:
+* `add -e Origami workshop -t Mon 1600-1800 -v Building A` adds an event with name `Origami workshop`,  
+time `Mon 1600-1800` and venue `Building A` to the events list.
+* `add -p John Tan -e Origami workshop` adds a participant `John Tan` to the event `Origami workshop`.
 
-**A**: {your answer here}
+### Remove an event or participant: `remove` 
+Removes an event from the event list, or a participant from an event.
 
-## Command Summary
+Format:
+* `remove -e EVENT` for removing an event from the event list.
+* `remove -p PARTICIPANT -e EVENT` for removing a participant from an event.
+
+Examples:
+* `remove -e Origami workshop` removes the event `Origami workshop` from the event list.
+* `remove -p John Tan -e Origami workshop` removes the participant `John Tan` from the event `Origami workshop`.
+
+### View all participants for an event: `view`
+Shows a list of all participants for an event.
+
+Format: `view -e EVENT`
 
-{Give a 'cheat sheet' of commands here}
+Examples:
+* `view -e Origami workshop` shows a list of all participants for the event `Origami workshop`.
+
+### Exiting the program: `exit`
+Exits the program.
+
+Format: `exit`
+
+## Command Summary
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+* View all commands: `view`
+* List all events: `list`
+* Add event: `add -e EVENT -t TIME -v VENUE`
+* Add participant to an event: `add -p PARTICIPANT -e EVENT`
+* Remove event: `remove -e EVENT`
+* Remove participant from an event: `remove -p PARTICIPANT -e EVENT`
+* View all participants for an event: `view -e EVENT`

docs/diagrams/ArchitectureSequence.puml

@@ -0,0 +1,62 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+Participant ":Main" as main
+Participant ":Ui" as ui
+Participant ":Parser" as parser
+Participant ":AddCommand" as command
+Participant ":EventList" as eventList
+
+main -> ui : getCommand()
+activate ui
+ui --> main : "add -e event -t 1200 -v venue"
+deactivate ui
+
+create parser
+main -> parser : Parser()
+activate parser
+parser --> main : :Parser
+deactivate parser
+
+main -> parser : parseCommand("add -e event -t 1200 -v venue")
+activate parser
+
+create command
+parser -> command : AddCommand("event", "1200", "venue")
+activate command
+command --> parser : :AddCommand
+deactivate command
+
+parser --> main : command:AddCommand
+deactivate parser
+destroy parser
+
+main -> command : setData(events:EventList)
+activate command
+command --> main
+deactivate command
+
+main -> command : execute()
+activate command
+
+command -> eventList : addEvent("event", "1200", "venue")
+activate eventList
+eventList --> command
+deactivate eventList
+
+command --> main
+deactivate command
+
+main -> ui : showOutputToUser(command: Command)
+activate ui
+
+ui -> command : getMessage()
+activate command
+
+command --> ui : :String
+deactivate command
+
+ui --> main
+deactivate ui
+
+@enduml

docs/diagrams/OverallArchitecture.puml

@@ -0,0 +1,45 @@
+@startuml
+'https://plantuml.com/class-diagram
+
+class Main {
+}
+
+Main --> Ui
+Main --> Storage
+Main --> EventList
+Main ..> Parser
+Main ..> Command
+
+class Ui {
+}
+
+Ui ..> Command
+
+class Parser {
+}
+
+Parser ..> Command
+
+class Storage {
+}
+
+Storage ..> EventList
+
+abstract class Command {
+}
+
+Command <|-- AddCommand
+Command <|-- ExitCommand
+Command <|-- ListCommand
+Command <|-- XYZCommand
+
+Command ..> EventList
+
+class EventList {
+}
+
+EventList *--> "*" Event
+
+Event *--> "*" Participant
+
+@enduml