You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/UserGuide.md
+36-5Lines changed: 36 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -129,13 +129,17 @@ If you would like a detailed look into each of the features WedLog has to offer,
129
129
130
130
## 2. Getting Started
131
131
132
-
1. Ensure you have Java `11` or above installed in your Computer.
132
+
1. Ensure you have Java version `11` or above installed in your Computer.
133
+
- You may refer to [this guide](https://blog.hubspot.com/website/check-java-verison) to check the Java version running on your computer.
134
+
- If your computer is not running Java version `11` or above, you may refer to these guides ([Windows](https://www.codejava.net/java-se/download-and-install-java-11-openjdk-and-oracle-jdk), [Mac](https://java.tutorials24x7.com/blog/how-to-install-java-11-on-mac))
135
+
for instructions on how to install Jave version `11` on your computer.
133
136
134
-
2. Download the latest `wedlog.jar` from [here](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases).
135
137
136
-
3. Copy the file to the folder you want to use as the _home folder_ for your WedLog.
138
+
2. Download the latest `wedlog.jar` file by clicking [here](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases/download/v1.4/wedlog.jar).
137
139
138
-
4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar wedlog.jar` command to run the application.<br>
140
+
3. Move the `wedlog.jar` file to the folder you want to use as the home folder for WedLog. You are encouraged to create a new folder specifically for WedLog and to move the `wedlog.jar` file into that folder. All data created by WedLog will be stored in this folder.
141
+
142
+
4. Open the WedLog application by double-clicking on the `wedlog.jar` file. If this does not work, [open your computer's terminal](https://towardsdatascience.com/a-quick-guide-to-using-command-line-terminal-96815b97b955), [navigate to the folder](https://tutorials.codebar.io/command-line/introduction/tutorial.html) containing `wedlog.jar`, and type `java -jar wedlog.jar` to start the application.
139
143
140
144
5. A window similar to the one below should appear in a few seconds. Note how the app contains some sample data.
141
145
@@ -974,12 +978,39 @@ Upon exit, the latest data is saved to your computer at `data/addressbook.json`.
<!--@@author p-xp-adapted from https://ay2324s1-cs2103t-w11-2.github.io/tp/UserGuide.html#faq-->
977
982
978
983
**Q**: How do I transfer my data to another Computer?<br>
979
-
**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.
984
+
**A**: Install WedLog on the other computer and replace the data file it creates with your existing data file. This data file
985
+
can be located in your existing WedLog home folder.
986
+
987
+
<br />
988
+
989
+
**Q**: Is there somewhere I can refer to all the commands at one glance?<br>
990
+
**A**: You may refer to our [command summary](#9-command-summary) section for a quick overview of all the commands available in WedLog.
980
991
981
992
<br />
982
993
994
+
**Q**: I accidentally deleted my data file. How can I recover my lost data?<br>
995
+
**A**: Please try looking for the deleted file in your computer's recycle bin. Once located, simply move the file from the recycle bin into the same folder as the `wedlog.jar` file.
996
+
Unfortunately, in the event that you cannot locate the deleted file in your recycle bin, we are
997
+
unable to help you recover your lost data.
998
+
999
+
<br />
1000
+
1001
+
**Q**: Can I use WedLog without an internet connection?<br>
1002
+
**A**: Yes, the WedLog application does not require internet connection to run.
1003
+
1004
+
<br />
1005
+
1006
+
**Q**: My wedding is over. How can I remove WedLog from my computer?<br>
1007
+
**A**: We hope you had a good wedding planning journey with WedLog! If you placed WedLog inside a dedicated folder during the installation process,
1008
+
simply delete the entire folder. Otherwise, you will have to find and delete the following files individually: `wedlog.jar`, `addressbook.log.0`, `preferences.json`, `config.json`, alongside the `data` folder.
Copy file name to clipboardExpand all lines: docs/team/p-xp.md
+32-21Lines changed: 32 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -3,47 +3,58 @@ layout: default.md
3
3
title: "Pan Xinping's Project Portfolio Page"
4
4
---
5
5
6
-
#Overview
6
+
### Project: WedLog
7
7
8
8
WedLog is a desktop application created for partners getting married that helps them manage the guests and vendors involved in the wedding.
9
9
The user interacts with it using a CLI, and it has a GUI created with JavaFX.
10
10
It is written in Java, and has about 10 kLoC. This project is based on [AddressBook - Level 3](https://se-education.org/addressbook-level3/).
11
11
12
12
Given below are my contributions to the project.
13
13
14
-
***New Feature**: Added the ability to add guests and vendors.
14
+
### Features
15
+
1.**New Feature**: Added the ability to add guests and vendors.
15
16
* What it does: Allows users to add new guests and vendors with all the associated fields to WedLog.
16
17
* Justification: This feature is central to the product as users cannot manage guests and vendors without being able to add them.
17
18
* Highlights: The implementation was challenging as guests and vendors had optional fields which users could choose not to fill in.
18
19
19
-
***New Feature**: Added the ability to edit guests.
20
+
<br>
21
+
22
+
2.**New Feature**: Added the ability to edit guests.
20
23
* What it does: Allows the user to edit fields of a guest.
21
24
* Justification: This feature improves the product significantly because a user may want to modify guest information and the app should provide an easy way to do so without having to remove and add the guest back.
22
25
* Highlights: The implementation was challenging because guests have optional fields which can be removed by using empty prefixes in the edit command. This required a careful consideration of design alternatives.
23
26
24
-
***New Feature**: Added the ability to filter guests by fields that stored information as tags (i.e., Dietary Requirements and Tags fields).
27
+
<br>
28
+
29
+
3.**New Feature**: Added the ability to filter guests by fields that stored information as tags (i.e., Dietary Requirements and Tags fields).
25
30
* What it does: Allows users to filter all guests using tag fields.
26
31
* Justification: This feature improves the product significantly as users may want to view all users that belong to a certain category (e.g. "vegans", or "classmates") without searching for them individually.
27
32
* Highlights:
28
33
* The implementation was challenging as unlike non-tag fields, tag fields can store multiple values (e.g. a guest may have two Dietary Requirements tags). Hence, there was a need to carefully consider use cases to decide on the final design where users can filter via multiple tags.
29
34
* Ensured high test effectiveness and efficiency by applying test heuristics like equivalence partitions to test designs (see `TagPredicateTest` and `GuestDietaryPredicateTest`).
* Organised team meeting agenda based on weekly deliverables and tracked list of TODOs determined during team discussions.
35
-
* Allocated issues identified in PED to team members on GitHub.
36
-
37
-
***Documentation**:
38
-
* User Guide:
39
-
* Added documentation for `guest edit`[\#127](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/127)
40
-
* Updated documentation for `guest add`[\#105](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/105), `vendor add`[\#106](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/106), and`guest filter`[\#153](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/153)
41
-
* Developer Guide:
42
-
* Added implementation details of the `add` feature [\#150](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/150), [\#268](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/268)
43
-
* Wrote Appendix D: Effort [\#268](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/268)
* Added documentation for `guest edit`: [\#127](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/127)
42
+
* Updated documentation for `guest add`: [\#105](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/105)
43
+
* Updated documentation for `vendor add`: [\#106](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/106)
44
+
* Updated documentation for `guest filter`: [\#153](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/153)
45
+
* Enhanced Quick Start and FAQ sections: [\#276](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/276)
46
+
* Credits: FAQ section was partially adapted from [AY2324S1-CS2103T-W11-2](https://github.com/AY2324s1-cs2103t-w11-2/tp/).
47
+
* Developer Guide:
48
+
* Added implementation details of the `add` feature: [\#150](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/150), [\#268](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/268)
49
+
* Wrote Appendix D Effort: [\#268](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/268)
50
+
51
+
### Contributions to team tasks
52
+
* Organised team meeting agenda based on weekly deliverables and tracked deadlines determined during team discussions.
53
+
* Allocated issues identified in PED to team members on GitHub.
Copy file name to clipboardExpand all lines: docs/team/samuelim01.md
+25-23Lines changed: 25 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -9,28 +9,26 @@ WedLog is a desktop application created for partners getting married that helps
9
9
10
10
Given below are my contributions to the project.
11
11
12
-
***New Feature**: Modified some fields to be optional for guests and vendors.
13
-
* What it does: allows the user to leave optional fields empty for guests and vendors.
14
-
* Justification: This feature improves the product significantly because a user may not want to specify all the fields of a guest or vendor, and the app should provide the flexibility for the user to do so.
15
-
* Credits: Partially adapted from [AY2324S1-CS2103T-W08-3](https://github.com/AY2324S1-CS2103T-W08-3/tp/).
16
-
17
-
***New Feature**: Added the ability to edit vendors.
18
-
* What it does: allows the user to edit fields of a vendor.
19
-
* Justification: This feature improves the product significantly because a user may want to modify vendor information and the app should provide an easy way to do so without having to remove and add back the vendor.
20
-
* Highlights: The implementation was challenging because vendors have optional fields which can be removed by using empty prefixes in the edit command. This required a careful consideration of design alternatives.
21
-
22
-
***New Feature**: Added the ability to undo/redo previous commands.
23
-
* 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.
24
-
* 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.
25
-
* Credits: Adapted from [AddressBook Level-4](https://github.com/se-edu/addressbook-level4).
1.**New Feature**: Modified some fields to be optional for guests and vendors.
14
+
* What it does: allows the user to leave optional fields empty for guests and vendors.
15
+
* Justification: This feature improves the product significantly because a user may not want to specify all the fields of a guest or vendor, and the app should provide the flexibility for the user to do so.
16
+
* Credits: Partially adapted from [AY2324S1-CS2103T-W08-3](https://github.com/AY2324S1-CS2103T-W08-3/tp/).
17
+
18
+
2.**New Feature**: Added the ability to edit vendors.
19
+
* What it does: allows the user to edit fields of a vendor.
20
+
* Justification: This feature improves the product significantly because a user may want to modify vendor information and the app should provide an easy way to do so without having to remove and add back the vendor.
21
+
* Highlights: The implementation was challenging because vendors have optional fields which can be removed by using empty prefixes in the edit command. This required a careful consideration of design alternatives.
22
+
23
+
3.**New Feature**: Added the ability to undo/redo previous commands.
24
+
* 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.
25
+
* 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.
26
+
* Credits: Adapted from [AddressBook Level-4](https://github.com/se-edu/addressbook-level4).
0 commit comments