README.md

   

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.

FoodRem User Guide

Here is the link to our FoodRem User Guide!

FoodRem Developer Guide

Here is the link to our FoodRem Developer Guide!

Project Team

Mai Ting Kai

[Personal Github] [Project Portfolio Page]

Bryan Lim Jing Xiang

[Personal Github] [Project Portfolio Page]

Richard Dominick

[Personal Github] [Project Portfolio Page]

Tan Wei Lie Eugene

[Personal Github] [Project Portfolio Page]

Tan Yi Xian

[Personal Github] [Project Portfolio Page]

Acknowledgements

FoodRem is a brownfield software project based off AddressBook Level-3, taken under the CS2103T Software Engineering module held by the School of Computing at the National University of Singapore.

Java dependencies:

• Jackson for JSON-related operations
• JavaFX for GUI
• JUnit5 for testing

Documentation dependencies:

• Jekyll for rendering the website
• PlantUML for creating UML diagrams

Fonts used in FoodRem:

• FoodRem Java App:
  • Epilogue by Tyler Finck
  • JetBrains Mono by Philipp Nurullin and Konstantin Bulenkov
  • Montserrat by Julieta Ulanovsky et al.
• FoodRem Website:
  • Epilogue by Tyler Finck
  • Source Code Pro by Paul D. Hunt

Other acknowledgments:

• Material Design Icons:
  • food-turkey by Colton Wiscombe as FoodRem's App Icon
• Font Awesome 6 icons:
  • book as the "note" admonition icon
  • circle-info as the "info" admonition icon
  • fire-flame-curved as the "danger" admonition icon
  • lightbulb as the "tip" admonition icon
  • triangle-exclamation as the "warning" admonition icon
• Octicons:
  • git-merge for the PR badge used in the project PPPs
  • issue-closed for the issue badge used in the project PPPs
• Code acknowledgements:
  • Custom link fragment checker adapted from the World Wide Web Consortium
  • Pure CSS auto-incrementing heading counters adapted from @gvgramazio on StackOverflow
  • PDF styling of HTML pages following Michael Perrin's tutorial
  • Pure liquid admonitions adapted from @kimkyunghwan21 on GitHub
  • Pure liquid HTML table-of-contents from @allejo on GitHub
• Miscellaneous:
  • Docusaurus for admonition colors and styling
  • GitHub for "PR merged" and "issue closed" colors used in PPP badges
  • SchemeColor for admonition colors