From 886fd657b492a9e50b69908b21952f5bee82cf4e Mon Sep 17 00:00:00 2001 From: Richard Dominick <34370238+RichDom2185@users.noreply.github.com> Date: Sat, 5 Nov 2022 16:59:26 +0800 Subject: [PATCH 1/9] Remove unused data file --- docs/_data/projects.yml | 23 ----------------------- 1 file changed, 23 deletions(-) delete mode 100644 docs/_data/projects.yml diff --git a/docs/_data/projects.yml b/docs/_data/projects.yml deleted file mode 100644 index 8f3e50cb601..00000000000 --- a/docs/_data/projects.yml +++ /dev/null @@ -1,23 +0,0 @@ -- name: "AB-1" - url: https://se-edu.github.io/addressbook-level1 - -- name: "AB-2" - url: https://se-edu.github.io/addressbook-level2 - -- name: "AB-3" - url: https://se-edu.github.io/addressbook-level3 - -- name: "AB-4" - url: https://se-edu.github.io/addressbook-level4 - -- name: "Duke" - url: https://se-edu.github.io/duke - -- name: "Collate" - url: https://se-edu.github.io/collate - -- name: "Book" - url: https://se-edu.github.io/se-book - -- name: "Resources" - url: https://se-edu.github.io/resources From f810976ed83bd2fd58275f3dde598795af6254b2 Mon Sep 17 00:00:00 2001 From: Richard Dominick <34370238+RichDom2185@users.noreply.github.com> Date: Sat, 5 Nov 2022 17:08:55 +0800 Subject: [PATCH 2/9] Create FoodRem data file --- docs/_data/foodrem.yml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/_data/foodrem.yml diff --git a/docs/_data/foodrem.yml b/docs/_data/foodrem.yml new file mode 100644 index 00000000000..7c3d73131d6 --- /dev/null +++ b/docs/_data/foodrem.yml @@ -0,0 +1,4 @@ +acknowledgements: >- + FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), + taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) + held by the School of Computing at the National University of Singapore. From 26a7fb77580f96a71569c22efe8a9a53ad0c0f87 Mon Sep 17 00:00:00 2001 From: Richard Dominick <34370238+RichDom2185@users.noreply.github.com> Date: Sat, 5 Nov 2022 17:09:32 +0800 Subject: [PATCH 3/9] Use data file for acknowledgements source --- README.md | 3 ++- docs/_dg/Acknowledgements.md | 3 ++- docs/_ug/Acknowledgements.md | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6fe788d4672..9edd67d2e43 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,5 @@ FoodRem is an Inventory Management System that empowers small food and beverage ## Acknowledgements -FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore. + +{{ site.data.foodrem.acknowledgements }} diff --git a/docs/_dg/Acknowledgements.md b/docs/_dg/Acknowledgements.md index c7ff39c142d..eea5afdde52 100644 --- a/docs/_dg/Acknowledgements.md +++ b/docs/_dg/Acknowledgements.md @@ -1,5 +1,6 @@ -FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore. + +{{ site.data.foodrem.acknowledgements }} * Libraries used: [Jackson](https://github.com/FasterXML/jackson), [JavaFX](https://openjfx.io/), [Jekyll](https://jekyllrb.com/), [JUnit5](https://github.com/junit-team/junit5), [PlantUML](https://plantuml.com/) * Icons used: Icons for [FoodRem](https://mdi.bessarabov.com/icon/food-turkey), [admonitions](http://glyphicons.com/) diff --git a/docs/_ug/Acknowledgements.md b/docs/_ug/Acknowledgements.md index 5619eb9eff4..6e88262778e 100644 --- a/docs/_ug/Acknowledgements.md +++ b/docs/_ug/Acknowledgements.md @@ -1,5 +1,6 @@ -FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore. + +{{ site.data.foodrem.acknowledgements }} * Libraries used: [Jackson](https://github.com/FasterXML/jackson), [JavaFX](https://openjfx.io/), [Jekyll](https://jekyllrb.com/), [JUnit5](https://github.com/junit-team/junit5), [PlantUML](https://plantuml.com/) * Icons used: [FoodRem Logo](https://mdi.bessarabov.com/icon/food-turkey), [Admonition Icons](http://glyphicons.com/) From 368f16810ebb92badec0754a9153612d6d787f1e Mon Sep 17 00:00:00 2001 From: Richard Dominick <34370238+RichDom2185@users.noreply.github.com> Date: Sat, 5 Nov 2022 17:16:25 +0800 Subject: [PATCH 4/9] Fix bug on project README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9edd67d2e43..793a8ae0ca8 100644 --- a/README.md +++ b/README.md @@ -9,5 +9,5 @@ FoodRem is an Inventory Management System that empowers small food and beverage ## Acknowledgements - -{{ site.data.foodrem.acknowledgements }} + +FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore. From ed10bf1279f2cac6c8a9913f71c6845015e7a85e Mon Sep 17 00:00:00 2001 From: Richard Dominick <34370238+RichDom2185@users.noreply.github.com> Date: Sat, 5 Nov 2022 17:17:16 +0800 Subject: [PATCH 5/9] Add TODOs --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 793a8ae0ca8..d4ac24dce0b 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,10 @@ ## FoodRem + FoodRem is an Inventory Management System that empowers small food and beverage (F&B) restaurant managers to manage inventory and obtain insights from inventory data. As a restaurant manager, leverage upon FoodRem's Inventory Management System during your daily operations. Utilize FoodRem's flexible tagging system to help you organize your inventory according to your business needs. Finally, streamline your business decisions by deriving insights from your inventory usage through FoodRem's statistics, keeping track of vital data such as food wastage. ## Acknowledgements - + FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore. From 38f0096c73c60c10bc8f75c6ef3415816d633c7e Mon Sep 17 00:00:00 2001 From: Richard Dominick <34370238+RichDom2185@users.noreply.github.com> Date: Sat, 5 Nov 2022 17:18:21 +0800 Subject: [PATCH 6/9] Move about summary to data file --- docs/_data/foodrem.yml | 9 +++++++++ docs/_ug/About.md | 3 ++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/_data/foodrem.yml b/docs/_data/foodrem.yml index 7c3d73131d6..f7b0302d5ba 100644 --- a/docs/_data/foodrem.yml +++ b/docs/_data/foodrem.yml @@ -2,3 +2,12 @@ acknowledgements: >- FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore. + +about: + summary: >- + FoodRem is an **Inventory Management System** that empowers small food and beverage (F&B) restaurant managers + to manage inventory and obtain insights from inventory data. As a restaurant manager, leverage upon FoodRem's + own **Inventory Management System**, where you can manage your inventory during your daily operations. Utilize + FoodRem's flexible **tagging system** to help you organize your inventory according to your business needs. + Finally, streamline your business decisions by deriving insights from your inventory usage through FoodRem's + **statistics**, keeping track of vital data such as food wastage. diff --git a/docs/_ug/About.md b/docs/_ug/About.md index 015b5737232..e2699dec2cf 100644 --- a/docs/_ug/About.md +++ b/docs/_ug/About.md @@ -1,5 +1,6 @@ -FoodRem is an **Inventory Management System** that empowers small food and beverage (F&B) restaurant managers to manage inventory and obtain insights from inventory data. As a restaurant manager, leverage upon FoodRem's own **Inventory Management System**, where you can manage your inventory during your daily operations. Utilize FoodRem's flexible **tagging system** to help you organize your inventory according to your business needs. Finally, streamline your business decisions by deriving insights from your inventory usage through FoodRem's **statistics**, keeping track of vital data such as food wastage. + +{{ site.data.foodrem.about.summary }} Simply by typing, efficiently interact with FoodRem without ever needing to touch your mouse! With a focus on user-friendliness, FoodRem is easy to learn! From 4bcde295a0efe2d790931507c05df4794451469d Mon Sep 17 00:00:00 2001 From: Richard Dominick <34370238+RichDom2185@users.noreply.github.com> Date: Sat, 5 Nov 2022 17:20:34 +0800 Subject: [PATCH 7/9] Reformat bryanljx's PPP --- docs/team/bryanljx.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/team/bryanljx.md b/docs/team/bryanljx.md index 812f0926087..4bdbf6063af 100644 --- a/docs/team/bryanljx.md +++ b/docs/team/bryanljx.md @@ -10,33 +10,31 @@ AddressBook - Level 3 is a desktop address book application used for teaching So Given below are my contributions to the project. **Refactoring**: + * **Refactored Feature**: Refactored `tag` model ([PR#140](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/140)) * What it does: encapsulates the idea of `tag` so that users can create and add `tag` to `item`. * Justification: This feature allows `item` to be classified into different categories. The refactoring allows for creating of any tags as well as updating of the restrictions we would like to place on names for `tag`. * Highlights: This refactoring allows users to create any `tag` they want. Through the use of regex, it also updates the restrictions we would like to place on names for `tag`, such as character limit or disallowed characters. - * **Refactored Feature**: Added storage for `tag` model ([PR#223](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/223)) * What it does: Adds storage functionality for the refactored `tag` model. * Justification: This feature is needed as we needed to store a separate list for `tag` besides the `item` list. **New feature**: + * **New Feature**: Added `renametag` command ([PR#179](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/179)) * What it does: Allows for renaming of existing `tag`. * Justification: Users might make errors in creating `tag` so we want to allow them to rename `tag`. - * **New Feature**: Added `deletetag` command ([PR#199](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/199)) * What it does: Allows for deletion of existing `tag`. * Justification: To allow users to delete `tag` no longer used. - * **New Feature**: Added `filtertag` command ([PR#302](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/302), [PR#353](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/353)) * What it does: Allows for filtering for `item` by `tag`. * Justification: This feature is the core functionality added by `tag`. We can classify `item` by `tag` so naturally we would like to filter by `tag`. * Credits: Thanks to `eugenetanwl3881` for catching a bug with the Ui related to `filtertag`. - * **Code contributed**: [RepoSense link](https://nus-cs2103-ay2223s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2022-09-16&tabOpen=true&tabType=authorship&tabAuthor=bryanljx&tabRepo=AY2223S1-CS2103T-W16-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false) * **Enhancements to existing features**: From fafcb81e213166aba23e14c30ee1b57fa5c97f17 Mon Sep 17 00:00:00 2001 From: Richard Dominick <34370238+RichDom2185@users.noreply.github.com> Date: Sat, 5 Nov 2022 17:21:28 +0800 Subject: [PATCH 8/9] Update PPP intro --- docs/team/bryanljx.md | 7 +++++-- docs/team/eugenetanwl3881.md | 7 +++++-- docs/team/ferusel.md | 7 +++++-- docs/team/richdom2185.md | 7 +++++-- docs/team/yixiann.md | 7 +++++-- 5 files changed, 25 insertions(+), 10 deletions(-) diff --git a/docs/team/bryanljx.md b/docs/team/bryanljx.md index 4bdbf6063af..1d315be64ee 100644 --- a/docs/team/bryanljx.md +++ b/docs/team/bryanljx.md @@ -3,9 +3,12 @@ layout: page title: Bryan Lim Jing Xiang's Project Portfolio Page --- -### Project: AddressBook Level 3 + +### Project: FoodRem +{: .no_toc} -AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +{{ site.data.foodrem.about.summary }} Given below are my contributions to the project. diff --git a/docs/team/eugenetanwl3881.md b/docs/team/eugenetanwl3881.md index 56267f849b5..8fa71d58a73 100644 --- a/docs/team/eugenetanwl3881.md +++ b/docs/team/eugenetanwl3881.md @@ -3,9 +3,12 @@ layout: page title: Eugene Tan's Project Portfolio Page --- -### Project: AddressBook Level 3 + +### Project: FoodRem +{: .no_toc} -AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +{{ site.data.foodrem.about.summary }} Given below are my contributions to the project. diff --git a/docs/team/ferusel.md b/docs/team/ferusel.md index 718ecfc6ea3..0ee2856ba1d 100644 --- a/docs/team/ferusel.md +++ b/docs/team/ferusel.md @@ -3,9 +3,12 @@ layout: page title: Mai Ting Kai's Project Portfolio Page --- -### Project: AddressBook Level 3 + +### Project: FoodRem +{: .no_toc} -AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +{{ site.data.foodrem.about.summary }} Given below are my contributions to the project. diff --git a/docs/team/richdom2185.md b/docs/team/richdom2185.md index c3e690b98b1..a5cadf8d491 100644 --- a/docs/team/richdom2185.md +++ b/docs/team/richdom2185.md @@ -3,9 +3,12 @@ layout: page title: Richard Dominick's Project Portfolio Page --- -### Project: AddressBook Level 3 + +### Project: FoodRem +{: .no_toc} -AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +{{ site.data.foodrem.about.summary }} Given below are my contributions to the project. diff --git a/docs/team/yixiann.md b/docs/team/yixiann.md index 6f4f5a121e6..9b0060a9256 100644 --- a/docs/team/yixiann.md +++ b/docs/team/yixiann.md @@ -3,9 +3,12 @@ layout: page title: Tan Yi Xian's Project Portfolio Page --- -### Project: AddressBook Level 3 + +### Project: FoodRem +{: .no_toc} -AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +{{ site.data.foodrem.about.summary }} Given below are my contributions to the project. From 5d963dd2437fd4b2de54d5ec7ca89db6657ca9ff Mon Sep 17 00:00:00 2001 From: Richard Dominick <34370238+RichDom2185@users.noreply.github.com> Date: Sat, 5 Nov 2022 17:26:24 +0800 Subject: [PATCH 9/9] Set up blank PPP layout template --- docs/_layouts/ppp.html | 4 ++++ docs/team/bryanljx.md | 2 +- docs/team/eugenetanwl3881.md | 2 +- docs/team/ferusel.md | 2 +- docs/team/richdom2185.md | 2 +- docs/team/yixiann.md | 2 +- 6 files changed, 9 insertions(+), 5 deletions(-) create mode 100644 docs/_layouts/ppp.html diff --git a/docs/_layouts/ppp.html b/docs/_layouts/ppp.html new file mode 100644 index 00000000000..aea6e959a2e --- /dev/null +++ b/docs/_layouts/ppp.html @@ -0,0 +1,4 @@ +--- +layout: page +--- +{{ content }} diff --git a/docs/team/bryanljx.md b/docs/team/bryanljx.md index 1d315be64ee..6613248f11a 100644 --- a/docs/team/bryanljx.md +++ b/docs/team/bryanljx.md @@ -1,5 +1,5 @@ --- -layout: page +layout: ppp title: Bryan Lim Jing Xiang's Project Portfolio Page --- diff --git a/docs/team/eugenetanwl3881.md b/docs/team/eugenetanwl3881.md index 8fa71d58a73..9a71b852cc9 100644 --- a/docs/team/eugenetanwl3881.md +++ b/docs/team/eugenetanwl3881.md @@ -1,5 +1,5 @@ --- -layout: page +layout: ppp title: Eugene Tan's Project Portfolio Page --- diff --git a/docs/team/ferusel.md b/docs/team/ferusel.md index 0ee2856ba1d..40e867056e0 100644 --- a/docs/team/ferusel.md +++ b/docs/team/ferusel.md @@ -1,5 +1,5 @@ --- -layout: page +layout: ppp title: Mai Ting Kai's Project Portfolio Page --- diff --git a/docs/team/richdom2185.md b/docs/team/richdom2185.md index a5cadf8d491..801b2d91bf6 100644 --- a/docs/team/richdom2185.md +++ b/docs/team/richdom2185.md @@ -1,5 +1,5 @@ --- -layout: page +layout: ppp title: Richard Dominick's Project Portfolio Page --- diff --git a/docs/team/yixiann.md b/docs/team/yixiann.md index 9b0060a9256..161becc1039 100644 --- a/docs/team/yixiann.md +++ b/docs/team/yixiann.md @@ -1,5 +1,5 @@ --- -layout: page +layout: ppp title: Tan Yi Xian's Project Portfolio Page ---