Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/andrefoo/tp
Browse files Browse the repository at this point in the history
  • Loading branch information
andrefoo committed Nov 13, 2023
2 parents 88aaa89 + c19c077 commit 98c2e72
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 31 deletions.
38 changes: 19 additions & 19 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,13 @@ The timetable will be displayed under all the profile information, and each prof

The days of the week are arranged from Monday to Sunday, and the timeslots are arranged from earliest to latest. Hope you like how it looks!

##### 2.6.3.1 Color coding
##### 2.6.3.2 Color coding

The event timeslots are color coded according to their type and vibe.

Blue for module (recurring), red for cca (recurring), and green for dated (non-recurring) events. Let TimetaBRO brighten your day up!

##### 2.6.3.1 Event block formation
##### 2.6.3.3 Event block formation

Each event block consists of the event name on the first line, and the start and end times on the second line. Simple yet elegant! (at least we hope you feel that way)

Expand Down Expand Up @@ -161,7 +161,7 @@ Personalise your profile information, such as your birthday and tags!

Format: `user n/NAME p/PHONE e/EMAIL a/ADDRESS b/BIRTHDAY [t/TAG]...​`

* Click [here](#parameters) to find out more about the parameter constraints.
* Click [here](#4-parameters) to find out more about the parameter constraints.

<div markdown="span" class="alert alert-primary">Tip:
A person can have any number of tags (including 0). Go crazy!
Expand Down Expand Up @@ -191,7 +191,7 @@ Format: `addschedule user type/EVENT_TYPE en/EVENT_NAME h/DAY_TIME`
where `DAY_TIME` must be entered in the format `Day HHMM HHMM`.<br>
`Day` is any day of the week fully spelt out and is case-insensitive, `HHMM` is a 24H time format to indicate the start time and end time!
- Event names will be changed to all upper case regardless of whether it was keyed it in lower case or upper case.
- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.


**Successful Command:**\
Expand Down Expand Up @@ -252,7 +252,7 @@ Format: `addevent user en/EVENT NAME h/DAY_TIME r/REMINDER`
where `DATE_TIME` must be entered in the format `DATE [YYYY-MM-DD] START_TIME [HHMM] END_TIME [HHMM]`. Date must be a valid date!
- You can set whether you want to enable reminders for this event by inputting `y/n` under `[REMINDER]` so you don't forget them!
- Event names will be changed to all upper case regardless of whether it was keyed it in lower case or upper case. TimetaBRO is hyping you up!
- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful Command:**\
Input:
Expand All @@ -268,7 +268,7 @@ FINAL SUBMISSION 2023-10-17 1500 1600 to [Your Name]
```

**Unsuccessful Command:**\
If a user uses the wrong format (i.e missing prefix, wrong event type),
If a user uses the wrong format (i.e. missing prefix, wrong event type),
this error message will be shown:
```
[error message]
Expand Down Expand Up @@ -314,7 +314,7 @@ Removes the specified recurring item from your schedule. Use it when your schedu

Format: `rmschedule user type/EVENT_TYPE en/EVENT_NAME`

- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful commands:**\
Input:
Expand Down Expand Up @@ -370,9 +370,9 @@ If there are multiple time slots with the same names, the command will remove ti

Removes the specified event from your schedule. Use it when your plans changes!

**Format:** `rmevent user en/EVENT_NAME`
Format: `rmevent user en/EVENT_NAME`

- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful commands:**\
Input:
Expand Down Expand Up @@ -411,7 +411,7 @@ Format: `add n/NAME p/PHONE e/EMAIL a/ADDRESS b/BIRTHDAY [t/TAG]...​`
* You can't have duplicate phone numbers or emails.
* Names can be alphanumeric. For Elon Musk's child's sake!
* Birthdays must be a valid date. We do check the calendars!
* Click [here](#parameters) to find out more about the parameter constraints.
* Click [here](#4-parameters) to find out more about the parameter constraints.

<div markdown="span" class="alert alert-primary">Tip:
A person can have any number of tags (including 0)
Expand Down Expand Up @@ -451,7 +451,7 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [b/BIRTHDAY] [t/TAG
* When editing tags, the existing tags of the person will be removed i.e. adding of tags is not cumulative. It's not ideal, but we're working on it!
* You can remove all the person’s tags by typing `t/` without
specifying any tags after it.
* Click [here](#parameters) to find out more about the parameter constraints.
* Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful Command:**

Expand Down Expand Up @@ -548,7 +548,7 @@ Format: `addschedule INDEX type/TYPE en/EVENT_NAME h/DAY_TIME`
- Event date and time will be equal to `DAY_TIME`
where `DAY_TIME` must be entered in the format `[monday/tuesday/wednesday/thursday/friday/saturday/sunday] HHMM [start time] HHMM [end time]`
- Event names will be changed to all upper case regardless of whether it was keyed it in lower case or upper case. Imagine TimetaBRO hyping you up!
- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful Command:**\
Input:
Expand Down Expand Up @@ -623,7 +623,7 @@ Format: `addevent INDEX en/EVENT_NAME h/DATE_TIME r/REMINDER`
where `DATE` must be entered in the format `YYYY-MM-DD HHMM [start time] HHMM [end time]`. Date must be a real date too!
- Users can set whether they want to enable reminders for this event by inputting `y/n` under `[REMINDER]`. Never forget these events again!
- Event names will be changed to all upper case regardless of whether it was keyed it in lower case or upper case.
- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful Command:**\
Input:
Expand All @@ -641,7 +641,7 @@ CS2030 FINALS 2023-10-31 1000 1400 to [Friend Name]
**Unsuccessful Command:**

If the user does not put an index or the index is not a positive integer,
this error messsage will be shown:
this error message will be shown:
```
Invalid index!
Index can only be 'user' or a positive integer!
Expand Down Expand Up @@ -698,7 +698,7 @@ Format: `rmschedule INDEX type/EVENT_TYPE en/EVENT_NAME`
- Removes an event titled `EVENT_NAME` from the specified friend at `INDEX`
- `EVENT_TYPE` is a prefix that can either be `module` or `CCA`. Pretty straightforward!
- `EVENT_NAME` must exist in the friend's schedule.
- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful commands:**\
Input:
Expand Down Expand Up @@ -772,7 +772,7 @@ Format: `rmevent INDEX en/EVENT_NAME`

- Removes an event titled `EVENT_NAME` from the specified friend at `INDEX`
- `EVENT_NAME` must exist in the friend's schedule.
- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful commands:**\
Input:
Expand Down Expand Up @@ -877,7 +877,7 @@ You have common free times with Alex Yeoh at:
[Sunday 0000 2400]
```

If your contact is a hustler and you have no common free times with a contact, it will display:
If your contact is a hustler, and you have no common free times with a contact, it will display:
```
You and [Friend's Name] have no common free time!
```
Expand Down Expand Up @@ -919,7 +919,7 @@ Sets a reminder for a **dated, non-recurring event** from the user's schedule. Y

Format: `setReminder EVENT_NAME`
- Set reminder for an event titled `EVENT_NAME` from the user's schedule.
- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful command:**\
Input:
Expand All @@ -946,7 +946,7 @@ Remove a reminder for a dated event from the user's schedule. Don't forget it!

Format: `rmReminder EVENT_NAME`
- Remove reminder for an event titled `EVENT_NAME` from the user's schedule.
- Click [here](#parameters) to find out more about the parameter constraints.
- Click [here](#4-parameters) to find out more about the parameter constraints.

**Successful command:**\
Input:
Expand Down
2 changes: 1 addition & 1 deletion docs/_sass/minima/_base.scss
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ table {
text-align: center;
}
.site-header:before {
content: "AB-3";
content: "TimetaBRO";
font-size: 32px;
}
}
Expand Down
17 changes: 12 additions & 5 deletions docs/team/kristayeo.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=kristayeo&sort=groupT
* Red for CCA (weekly recurring)
* Green for dated events (non-recurring)
* Displayed friend profile upon selection by mouse click from the friend list
* Refresh display profiles upon relevant command executions (user, edit, addschedule, addevent, rmschedule, rmevent)
* Refresh display profiles upon relevant command executions (`user`, `edit`, `addschedule`, `addevent`, `rmschedule`, `rmevent`)
* Created the following UI related classes:
* ListCellSelectedEvent.java
* SelectedFriendCard.java
Expand All @@ -35,18 +35,25 @@ https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=kristayeo&sort=groupT

**Contributions to the User Guide (UG):**

* Wrote about addschedule, addevent, rmschedule, rmevent for both user and friend
* Wrote the TimetaBRO User Interface
* Wrote about `addschedule`, `addevent`, `rmschedule`, `rmevent` for both user and friend.
* Contributed to the documentation of `edit`, `delete`, Viewing friend's profile, `cft`.
* Ensured all the outputs for their respective features were correct.
* Organised the UG, ensured that all the features followed the same format.
* Added necessary additional notes and proofread the UG, cleaned up mistakes.

**Contributions to the Developer Guide (DG):**

[to be added later]
* UI component of the Design
* Implementation: Click to View Friend Timetable Feature
* Product Scope: Target User Profile and Value Proposition
* Contributed to the Glossary
* Did formatting, organising of the code

**Contributions to team-based tasks:**

* Consistently worked with teammates that worked on the backend to ensure the smooth display of the UI.
* Occasionally approved and merged pull requests.
* Approved and merged pull requests.
* Wrote README.md and index.md

**Contributions beyond the project team:**

Expand Down
20 changes: 16 additions & 4 deletions docs/team/lululwtv.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Project Portfolio Page: TimetaBRO
---
layout: page
title: Edric Khiew's Project Portfolio Page
---

# Project: TimetaBRO

## Overview
TimetaBRO is a scheduling application that allows users to manage their own schedule as well as the schedules of their friends. It offers features such as adding and removing friends, adding and removing events, setting reminders, and finding common free times among friends. TimetaBRO is compatible with multiple operating systems and saves data automatically in a JSON file. It also allows advanced users to edit the data file directly. The application offers a command-line interface and provides a command summary for easy reference. TimetaBRO is a powerful tool for enhancing social connections and simplifying event planning.
Expand All @@ -22,17 +27,24 @@ https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=w12-4&sort=groupTitle
- Updated UG to include expected features that may not be expected by users, such as:
- Informing users in the UG that event names will be changed to all caps even if they did not key it in caps
- Add sample code for the commands I have added
- Wrote FAQ
- Wrote Known Issues
- Wrote Command Summary

**Contributions to the Developer Guide (DG):**

- Update DG on how addschedule command works
- Created sequence diagram for addschedule command
- Updated how Logic package works
- Added implementation section on `addschedule` command
- Added User Stories

**Contributions to team-based tasks:**

[to be added later]
- Fixed 20 bugs after PE-Dry run, which led to significant improvements in the code
- Kept track of code quality by fixing all checkstyle issues in gradle
- Kept track of team's submissions and deadlines, ensuring that all tasks are submitted on time by teammates

**Contributions beyond the project team:**

[to be added later]
- Took part in bug-catcher
- Took part in PE-D
4 changes: 2 additions & 2 deletions docs/team/owenyeo.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ TimetaBRO, your ultimate companion for managing your university life, social int
### Summary of Contributions

**Code contributed:**
https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=owenyeo&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22
[Link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=owenyeo&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22)

**Enhancements implemented:**
* **New Feature**: Added the ability to store user data, such as birthdays and schedules. It is stored in a Jackson file `userdata.json`
Expand Down Expand Up @@ -41,7 +41,7 @@ https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=owenyeo&sort=groupTit

**Contributions to the User Guide (UG):**
* Wrote the introduction
* Wrote About
* Wrote the About section
* Wrote the Quickstart
* Updated tone throughout the UG.

Expand Down

0 comments on commit 98c2e72

Please sign in to comment.