diff --git a/README.md b/README.md index c5fd8ba1f72..4a44f53a031 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,97 @@ 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. +## FoodRem User Guide + +Here is the link to our FoodRem [User Guide](https://ay2223s1-cs2103t-w16-2.github.io/tp/UserGuide.html)! + +## FoodRem Developer Guide + +Here is the link to our FoodRem [Developer Guide](https://ay2223s1-cs2103t-w16-2.github.io/tp/DeveloperGuide.html)! + +## Project Team + +### Mai Ting Kai + + + +[[Personal Github](https://github.com/ferusel)] +[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/ferusel)] + +### Bryan Lim Jing Xiang + + + +[[Personal Github](https://github.com/bryanljx)] +[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/bryanljx)] + +### Richard Dominick + + + +[[Personal Github](https://github.com/RichDom2185)] +[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/richdom2185)] + +### Tan Wei Lie Eugene + + + +[[Personal Github](https://github.com/eugenetanwl3881)] +[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/eugenetanwl3881)] + +### Tan Yi Xian + + + +[[Personal Github](https://github.com/yixiann)] +[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/yixiann)] + ## Acknowledgements FoodRem is a brownfield software project based off [AddressBook Level-3](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. + +Java dependencies: + +* [Jackson](https://github.com/FasterXML/jackson) for JSON-related operations +* [JavaFX](https://openjfx.io/) for GUI +* [JUnit5](https://github.com/junit-team/junit5) for testing + +Documentation dependencies: + +* [Jekyll](https://jekyllrb.com/) for rendering the website +* [PlantUML](https://plantuml.com/) for creating UML diagrams + +Fonts used in FoodRem: + +* FoodRem Java App: + * [Epilogue](https://fonts.google.com/specimen/Epilogue) by Tyler Finck + * [JetBrains Mono](https://fonts.google.com/specimen/JetBrains+Mono) by Philipp Nurullin and Konstantin Bulenkov + * [Montserrat](https://fonts.google.com/specimen/Montserrat) by Julieta Ulanovsky et al. +* FoodRem Website: + * [Epilogue](https://fonts.google.com/specimen/Epilogue) by Tyler Finck + * [Source Code Pro](https://fonts.google.com/specimen/Source+Code+Pro) by Paul D. Hunt + +Other acknowledgments: + +* Material Design Icons: + * [food-turkey](https://materialdesignicons.com/icon/food-turkey) by Colton Wiscombe as FoodRem's App Icon +* Font Awesome 6 icons: + * [book](https://fontawesome.com/icons/book) as the "note" admonition icon + * [circle-info](https://fontawesome.com/icons/circle-info) as the "info" admonition icon + * [fire-flame-curved](https://fontawesome.com/icons/fire-flame-curved) as the "danger" admonition icon + * [lightbulb](https://fontawesome.com/icons/lightbulb) as the "tip" admonition icon + * [triangle-exclamation](https://fontawesome.com/icons/triangle-exclamation) as the "warning" admonition icon +* Octicons: + * [git-merge](https://primer.style/octicons/git-merge-16) for the PR badge used in the project PPPs + * [issue-closed](https://primer.style/octicons/issue-closed-16) for the issue badge used in the project PPPs +* Code acknowledgements: + * [Custom link fragment checker](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/cli-test/linkchecker/check-links.js) adapted from the [World Wide Web Consortium](https://github.com/w3c/node-linkchecker) + * [Pure CSS auto-incrementing heading counters](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_sass/toc.scss) adapted from [@gvgramazio on StackOverflow](https://stackoverflow.com/a/51007932/9311854) + * [PDF styling of HTML pages](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_sass/pdf.scss) following Michael Perrin's [tutorial](https://www.michaelperrin.fr/blog/2019/11/printing-the-web-part-2-html-and-css-for-printing-books) + * [Pure liquid admonitions](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_sass/admonitions.scss) adapted from [@kimkyunghwan21 on GitHub](https://github.com/kimkyunghwan21/kimkyunghwan21.github.io/blob/master/_layouts/plugins/extension.liquid) + * [Pure liquid HTML table-of-contents](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_includes/toc.html) from [@allejo on GitHub](https://github.com/allejo/jekyll-toc) +* Miscellaneous: + * [Docusaurus](https://docusaurus.io/docs/markdown-features/admonitions) for admonition colors and styling + * [GitHub](https://github.com) for "PR merged" and "issue closed" colors used in PPP badges + * [SchemeColor](https://www.schemecolor.com/pastel-rainbow.php) for admonition colors diff --git a/copyright.txt b/copyright.txt index 76341f48edc..b328e7c351b 100644 --- a/copyright.txt +++ b/copyright.txt @@ -1,13 +1,9 @@ -Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob +Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob -Copyright by Colton Wiscombe - https://mdi.bessarabov.com/icon/food-turkey +FoodRem icon by Colton Wiscombe - https://materialdesignicons.com/icon/food-turkey - foodrem.png -- foodrem.ico - -Copyright by Jan Jan Kovařík - http://glyphicons.com/ -- calendar.png -- edit.png Website: - Fonts by Google Fonts - https://fonts.google.com/ -- Icons from Font Awesome - https://fontawesome.com/ +- Icons by Font Awesome - https://fontawesome.com/ +- Icons by Octicons - https://primer.style/octicons/ diff --git a/docs/_data/foodrem.yml b/docs/_data/foodrem.yml index 1e598c70086..ce0859b16ee 100644 --- a/docs/_data/foodrem.yml +++ b/docs/_data/foodrem.yml @@ -1,8 +1,48 @@ -acknowledgements: >- +acknowledgements: |- FoodRem is a brownfield software project based off [AddressBook Level-3](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. + Java dependencies: + * [Jackson](https://github.com/FasterXML/jackson) for JSON-related operations + * [JavaFX](https://openjfx.io/) for GUI + * [JUnit5](https://github.com/junit-team/junit5) for testing + + Documentation dependencies: + * [Jekyll](https://jekyllrb.com/) for rendering the website + * [PlantUML](https://plantuml.com/) for creating UML diagrams + + Fonts used in FoodRem: + * FoodRem Java App: + * [Epilogue](https://fonts.google.com/specimen/Epilogue) by Tyler Finck + * [JetBrains Mono](https://fonts.google.com/specimen/JetBrains+Mono) by Philipp Nurullin and Konstantin Bulenkov + * [Montserrat](https://fonts.google.com/specimen/Montserrat) by Julieta Ulanovsky et al. + * FoodRem Website: + * [Epilogue](https://fonts.google.com/specimen/Epilogue) by Tyler Finck + * [Source Code Pro](https://fonts.google.com/specimen/Source+Code+Pro) by Paul D. Hunt + + Other acknowledgments: + * Material Design Icons: + * [food-turkey](https://materialdesignicons.com/icon/food-turkey) by Colton Wiscombe as FoodRem's App Icon + * Font Awesome 6 icons: + * [book](https://fontawesome.com/icons/book) as the "note" admonition icon + * [circle-info](https://fontawesome.com/icons/circle-info) as the "info" admonition icon + * [fire-flame-curved](https://fontawesome.com/icons/fire-flame-curved) as the "danger" admonition icon + * [lightbulb](https://fontawesome.com/icons/lightbulb) as the "tip" admonition icon + * [triangle-exclamation](https://fontawesome.com/icons/triangle-exclamation) as the "warning" admonition icon + * Octicons: + * [git-merge](https://primer.style/octicons/git-merge-16) for the PR badge used in the project PPPs + * [issue-closed](https://primer.style/octicons/issue-closed-16) for the issue badge used in the project PPPs + * Code acknowledgements: + * [Custom link fragment checker](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/cli-test/linkchecker/check-links.js) adapted from the [World Wide Web Consortium](https://github.com/w3c/node-linkchecker) + * [Pure CSS auto-incrementing heading counters](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_sass/toc.scss) adapted from [@gvgramazio on StackOverflow](https://stackoverflow.com/a/51007932/9311854) + * [PDF styling of HTML pages](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_sass/pdf.scss) following Michael Perrin's [tutorial](https://www.michaelperrin.fr/blog/2019/11/printing-the-web-part-2-html-and-css-for-printing-books) + * [Pure liquid admonitions](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_sass/admonitions.scss) adapted from [@kimkyunghwan21 on GitHub](https://github.com/kimkyunghwan21/kimkyunghwan21.github.io/blob/master/_layouts/plugins/extension.liquid) + * [Pure liquid HTML table-of-contents](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_includes/toc.html) from [@allejo on GitHub](https://github.com/allejo/jekyll-toc) + * Miscellaneous: + * [Docusaurus](https://docusaurus.io/docs/markdown-features/admonitions) for admonition colors and styling + * [GitHub](https://github.com) for "PR merged" and "issue closed" colors used in PPP badges + * [SchemeColor](https://www.schemecolor.com/pastel-rainbow.php) for admonition colors about: - summary: >- + 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, you can easily view and edit 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** -- you can keep track of metrics such as food wastage amount if you wish! - summary_dg: >- + summary_dg: |- 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. Users can leverage FoodRem's **Inventory Management System** to view and edit their inventory during daily operations. FoodRem's **tagging system** helps users organize their inventory according to their business needs. FoodRem also derives insights from inventory usage through its **statistics**. diff --git a/docs/_dg/Acknowledgements.md b/docs/_dg/Acknowledgements.md index eea5afdde52..1570a474019 100644 --- a/docs/_dg/Acknowledgements.md +++ b/docs/_dg/Acknowledgements.md @@ -1,6 +1,3 @@ {{ 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 6e88262778e..62936f93ea6 100644 --- a/docs/_ug/Acknowledgements.md +++ b/docs/_ug/Acknowledgements.md @@ -1,6 +1,3 @@ {{ 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/) diff --git a/docs/index.md b/docs/index.md index e1e05426bc9..27c7184f2b9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,4 +16,5 @@ title: FoodRem ###### Acknowledgements -* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5) + +{{ site.data.foodrem.acknowledgements }}