FoodRem

FoodRem is a desktop application for F&B businesses to manage their inventory. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

If you are interested in using FoodRem, head over to the Installation Guide.
If you are interested about developing FoodRem, the Developer Guide is a good place to start.

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