Skip to content

Commit

Permalink
Add new try out your first commands section
Browse files Browse the repository at this point in the history
  • Loading branch information
@peienlim
peienlim committed Apr 14, 2024
1 parent 64e1f65 commit d8b1086
Show file tree
Hide file tree
Showing 2 changed files with 202 additions and 40 deletions.
202 changes: 167 additions & 35 deletions data/addressbook.json
View file
Original file line number Diff line number Diff line change
@@ -1,56 +1,188 @@
{
"persons" : [ {
"name" : "Tom",
"name" : "Alex Yeoh",
"phone" : "99999999",
"email" : "[email protected]",
"address" : "Blk 30 Geylang Street 29, #06-40",
"tags" : [ "operations" ],
"eventTags" : [ {
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
}, {
"name" : "Bernice Yu",
"phone" : "99272758",
"email" : "[email protected]",
"address" : "Blk 30 Lorong 3 Serangoon Gardens, #07-18",
"tags" : [ "marketing" ],
"eventTags" : [ {
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
}, {
"name" : "Charlotte Oliveiro",
"phone" : "93210283",
"email" : "[email protected]",
"address" : "Blk 11 Ang Mo Kio Street 74, #11-04",
"tags" : [ "logistics" ],
"eventTags" : [ {
"tagName" : "Rag",
"description" : "Rag event",
"startDate" : "2024-04-05T14:00:00",
"endDate" : "2024-04-05T16:00:00"
} ]
}, {
"name" : "David Li",
"phone" : "91031282",
"email" : "[email protected]",
"address" : "Blk 436 Serangoon Gardens Street 26, #16-43",
"tags" : [ "publicity" ],
"eventTags" : [ {
"tagName" : "Rag",
"description" : "Rag event",
"startDate" : "2024-04-05T14:00:00",
"endDate" : "2024-04-05T16:00:00"
} ]
}, {
"name" : "Irfan Ibrahim",
"phone" : "92492021",
"email" : "[email protected]",
"address" : "Blk 47 Tampines Street 20, #17-35",
"tags" : [ "publicity" ],
"eventTags" : [ {
"tagName" : "Rag",
"description" : "Rag event",
"startDate" : "2024-04-05T14:00:00",
"endDate" : "2024-04-05T16:00:00"
} ]
}, {
"name" : "Roy Balakrishnan",
"phone" : "92624417",
"email" : "[email protected]",
"address" : "Blk 45 Aljunied Street 85, #11-31",
"tags" : [ "VPD" ],
"eventTags" : [ {
"tagName" : "Rag",
"description" : "Rag event",
"startDate" : "2024-04-05T14:00:00",
"endDate" : "2024-04-05T16:00:00"
} ]
}, {
"name" : "Tom Goh",
"phone" : "91234812",
"email" : "[email protected]",
"address" : "NUS",
"tags" : [ "interesting" ],
"address" : "Blk 98 Telok Blangah Street 85, #11-09",
"tags" : [ "secretary" ],
"eventTags" : [ {
"tagName" : "orientation",
"description" : "Orientation!",
"startDate" : "2024-04-04T02:02:02",
"endDate" : "2024-04-05T02:02:02"
}, {
"tagName" : "camping",
"description" : "CAMP!!",
"startDate" : "2024-04-04T02:02:02",
"endDate" : "2024-04-05T02:02:02"
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
}, {
"name" : "John",
"name" : "John Tan",
"phone" : "91232345",
"email" : "[email protected]",
"address" : "NTU",
"tags" : [ ],
"address" : "Blk 1 Hougang Street 3, #07-18",
"tags" : [ "operations" ],
"eventTags" : [ {
"tagName" : "orientation",
"description" : "Orientation!",
"startDate" : "2024-04-04T02:02:02",
"endDate" : "2024-04-05T02:02:02"
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
}, {
"name" : "Ben",
"name" : "Ben Tan",
"phone" : "83478596",
"email" : "[email protected]",
"address" : "NA",
"tags" : [ "friendly" ],
"tags" : [ "operations" ],
"eventTags" : [ {
"tagName" : "camping",
"description" : "CAMP!!",
"startDate" : "2024-04-04T02:02:02",
"endDate" : "2024-04-05T02:02:02"
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
}, {
"name" : "Ann Lee",
"phone" : "82882919",
"email" : "[email protected]",
"address" : "NA",
"tags" : [ "head", "publicity" ],
"eventTags" : [ {
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
}, {
"name" : "Amy Lim",
"phone" : "82882919",
"email" : "[email protected]",
"address" : "AMK Blk 91",
"tags" : [ "head", "operations" ],
"eventTags" : [ {
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
}, {
"name" : "Betty Ho",
"phone" : "93882919",
"email" : "[email protected]",
"address" : "AMK Blk 10",
"tags" : [ "logistics" ],
"eventTags" : [ {
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
}, {
"name" : "Zack Goh",
"phone" : "82820119",
"email" : "[email protected]",
"address" : "AMK Blk 10",
"tags" : [ "logistics" ],
"eventTags" : [ {
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
}, {
"name" : "Xan",
"phone" : "82882919",
"email" : "[email protected]",
"address" : "Bishan Blk 10",
"tags" : [ "logistics", "VPD" ],
"eventTags" : [ {
"tagName" : "Rag",
"description" : "Rag event",
"startDate" : "2024-04-05T14:00:00",
"endDate" : "2024-04-05T16:00:00"
}, {
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
} ]
} ],
"tagList" : [ "notcool", "fine", "friendly", "interesting" ],
"tagList" : [ "head", "marketing", "secretary", "operations", "logistics", "neighbours", "VPD", "publicity" ],
"eventTagList" : [ {
"tagName" : "orientation",
"description" : "Orientation!",
"startDate" : "2024-04-04T02:02:02",
"endDate" : "2024-04-05T02:02:02"
}, {
"tagName" : "camping",
"description" : "CAMP!!",
"startDate" : "2024-04-04T02:02:02",
"endDate" : "2024-04-05T02:02:02"
"tagName" : "Flag",
"description" : "Flag event",
"startDate" : "2024-04-10T18:00:00",
"endDate" : "2024-04-10T22:00:00"
}, {
"tagName" : "Rag",
"description" : "Rag event",
"startDate" : "2024-04-05T14:00:00",
"endDate" : "2024-04-05T16:00:00"
} ]
}
40 changes: 35 additions & 5 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Thank you for downloading EventBook as your project management software of choic
Choose a topic from the table of contents below / or in the sidebar to find answers, or step-by-step
guides on how to use EventBook.
<!-- * Table of Contents -->
<page-nav-print></page-nav-print>
<page-nav-print>

--------------------------------------------------------------------------------------------------------------------
## Product Overview
Expand Down Expand Up @@ -104,9 +104,40 @@ This detailed overview enables users to quickly access essential contact informa
**Note:**<br>
The default tab on entering the app is the `All` tab, with all contacts in EventBook displayed in the Result Panel.
</box>



## Try Out Your First Commands!
Ready to dive in? Let's try out a few commands to get you started with EventBook:
1. Open EventBook if you haven't already done so by following the steps outlined in the [Quick Start](#quick-start) section.
2. First, let's start with **adding a new contact**. In the command box, type the following command: <br>
```
add n/Xavier Tan p/98765432 e/[email protected] a/Ang Mo Kio street 2, Block 123, #01-01
```
* This command will add a new contact named "Xavier Tan" with the provided phone number, email address, and address details.
* Scroll to the bottom of the list of contacts, you will find that Xavier Tan has been successfully added to your contacts!
3. Now, let's **tag** Xavier as the vice-project director `VPD` of the `Flag` event. Enter the following command in the command box:
```
assign Xavier Tan t/VPD t/E-Flag
```
* You will see Xavier has been assigned two new tags: a blue `VPD` tag and a purple `Flag` event tag.
4. Next, let's try **switching to the Flag event tab** to view its members. In the command box, type the following command: <br>
```
switch Flag
```
* Notice that the highlighted tab on the left switches from the `All` tab to the `Flag` tab, and all listed contacts have the `Flag` event tag.
5. To **switch back to the `All` tab** to view all your contacts, enter the following command:
```
list
```
6. Experiment with other basic commands that we have listed in the [Quick Start](#quick-start) section the to get a feel for how EventBook works! <br>

Now that you are all warmed up, let's delve deeper into the details of each command and how you can use them to supercharge your event management in the next section!

--------------------------------------------------------------------------------------------------------------------
## Command Format

**Things to take note of before you write your first command:**<br>
**Things to take note of before about the format of commands:**<br>

* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.
Expand All @@ -130,9 +161,7 @@ If you are using a PDF version of this document, be careful when copying and pas

</box>

--------------------------------------------------------------------------------------------------------------------

## Features
## Commands

### Viewing help : `help`

Expand Down Expand Up @@ -360,6 +389,7 @@ EventBook data are saved in the hard disk automatically after any command that c
EventBook 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.

<box type="warning" seamless>

**Caution:**
If your changes to the data file makes its format invalid, EventBook 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.<br>
Furthermore, certain edits can cause the EventBook to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
Expand Down

0 comments on commit d8b1086

Please sign in to comment.