[CS2103T-W16-2] FoodRem

.github/workflows/build.yml

@@ -0,0 +1,85 @@
+name: Build
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+
+jobs:
+  jarfile:
+    runs-on: ubuntu-20.04
+    outputs:
+      upload_url: ${{ steps.create_release.outputs.upload_url }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@main
+        with:
+          ref: master
+      - name: Validate Gradle Wrapper
+        uses: gradle/wrapper-validation-action@v1
+      - name: Setup JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+          java-package: jdk+fx
+      - name: Create JAR file
+        run: ./gradlew shadowJar
+      - name: Generate tag name from time
+        id: tagname
+        run: echo ::set-output name=TAGNAME::$(echo ${{ github.event.repository.pushed_at }} | sed -e 's/^../AR/')
+      - name: Generate release name from time
+        id: releasename
+        run: echo "::set-output name=RELEASENAME::$(date -d @${{ github.event.repository.pushed_at }})"
+      - name: Create release on GitHub
+        id: create_release # We need the id to refer to it in the next step
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.tagname.outputs.TAGNAME }}
+          release_name: Auto-release ${{ steps.releasename.outputs.RELEASENAME }}
+          body: 'Auto-created release from branch "${{ github.ref_name }}"'
+      - name: Upload JAR file to GitHub releases
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./build/libs/foodrem.jar
+          asset_name: foodrem.jar
+          asset_content_type: application/java-archive
+  pdfs:
+    needs: jarfile
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@main
+      - name: Set up PATH
+        run: echo "$HOME/.gem/ruby/2.7.0/bin" >> $GITHUB_PATH
+      - name: Set up server dependencies
+        working-directory: ${{ github.workspace }}/docs
+        run: gem install --user-install bundler && bundle install
+      - name: Create PDFs of UG and DG
+        working-directory: ${{ github.workspace }}/docs
+        run: ./make-pdf.sh
+      - name: Upload UG to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.jarfile.outputs.upload_url }}
+          asset_path: ./docs/release/UserGuide.pdf
+          asset_name: UserGuide.pdf
+          asset_content_type: application/pdf
+      - name: Upload DG to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.jarfile.outputs.upload_url }}
+          asset_path: ./docs/release/DeveloperGuide.pdf
+          asset_name: DeveloperGuide.pdf
+          asset_content_type: application/pdf

.github/workflows/check-links.yml

@@ -0,0 +1,21 @@
+name: Check all links on website are valid
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  check-links:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@main
+      - name: Set up PATH
+        run: echo "$HOME/.gem/ruby/2.7.0/bin" >> $GITHUB_PATH
+      - name: Set up server dependencies
+        working-directory: ${{ github.workspace }}/docs
+        run: gem install --user-install bundler && bundle install
+      - name: Set up checker dependencies
+        working-directory: ${{ github.workspace }}/cli-test/linkchecker
+        run: npm install
+      - name: Set up server and check all links are valid
+        working-directory: ${{ github.workspace }}/cli-test/linkchecker
+        run: python serve-and-check.py

.github/workflows/check-ppp-edited.yml

@@ -0,0 +1,49 @@
+name: Check PPP is updated
+
+on: [workflow_dispatch, pull_request]
+
+jobs:
+  check-ppp:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@main
+      - name: Query GraphQL API
+        uses: octokit/[email protected]
+        id: get_latest_prs
+        with:
+          query: |
+            query PRs {
+              repository(owner: "AY2223S1-CS2103T-W16-2", name: "tp") {
+                pullRequests(last: 100) {
+                  totalCount
+                  edges {
+                    node {
+                      title
+                      merged
+                      resourcePath
+                      participants(first: 10) {
+                        edges {
+                          node {
+                            login
+                          }
+                        }
+                      }
+                      headRepositoryOwner {
+                        login
+                      }
+                      number
+                      closed
+                    }
+                  }
+                }
+              }
+            }
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Save query data to file
+        working-directory: ${{ github.workspace }}/cli-test/ppp-checker
+        run: "echo '${{ steps.get_latest_prs.outputs.data }}' > data.json"
+      - name: Validate all PRs are included in PPP
+        working-directory: ${{ github.workspace }}/cli-test/ppp-checker
+        run: ./check-ppp-is-present.sh ${{ github.event.pull_request.user.login }}

.github/workflows/gradle.yml

@@ -32,7 +32,7 @@ jobs:
       - name: Setup JDK 11
         uses: actions/setup-java@v1
         with:
-          java-version: '11'
+          java-version: "11"
           java-package: jdk+fx
 
       - name: Build and check with Gradle
@@ -43,4 +43,4 @@ jobs:
         with:
           directory: ${{ github.workspace }}/build/reports/jacoco/coverage
           files: coverage.xml
-          fail_ci_if_error: true
+          fail_ci_if_error: false

.gitignore

@@ -1,22 +1,24 @@
 # Gradle build files
-/.gradle/
-/build/
+.gradle/
+build/
 src/main/resources/docs/
 
+# VSCode build files
+bin/
+
 # IDEA files
-/.idea/
-/out/
-/*.iml
+.idea/
+out/
+*.iml
 
 # Storage/log files
-/data/
-/config.json
-/preferences.json
-/*.log.*
+data/
+config.json
+preferences.json
+*.log.*
 
 # Test sandbox files
 src/test/data/sandbox/
 
 # MacOS custom attributes files created by Finder
 .DS_Store
-docs/_site/

.markdownlint.json

@@ -0,0 +1,35 @@
+{
+  "MD004": { // Unordered list style
+    "style": "asterisk"
+  },
+  "MD009": { // Trailing spaces
+    "br_spaces": 0
+  },
+  "MD013": false, // Line length
+  "MD029": { // Ordered list item prefix
+    "style": "one"
+  },
+  "MD033": { // Inline HTML
+    "allowed_elements": ["sub", "sup", "br", "kbd"]
+  },
+  "MD035": { // Horizontal rule style
+    "style": "---"
+  },
+  "MD044": { // Proper names should have the correct capitalization
+    "names": ["FoodRem", "User Guide", "Developer Guide", "Command Input Box", "Command Output Box", "Item List Box"],
+    "code_blocks": false
+  },
+  "MD046": { // Code block style
+    "style": "fenced"
+  },
+  "MD048": { // Code fence style
+    "style": "backtick"
+  },
+  "MD049": { //  Emphasis style should be consistent
+    "style": "underscore"
+  },
+  "MD050": { // Strong style should be consistent
+    "style": "asterisk"
+  },
+  "MD051": false // Link fragments should be valid
+}

README.md

@@ -1,14 +1,105 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2223S1-CS2103T-W16-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S1-CS2103T-W16-2/tp/actions)
+ [![CI Status](https://github.com/AY2223S1-CS2103T-W16-2/tp/workflows/Build/badge.svg)](https://github.com/AY2223S1-CS2103T-W16-2/tp/actions)
+ [![codecov](https://codecov.io/gh/AY2223S1-CS2103T-W16-2/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2223S1-CS2103T-W16-2/tp)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+## FoodRem
+
+<!-- TODO: Check that this matches {{ site.data.foodrem.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 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
+
+<img src="docs/images/ferusel.png" width="200px">
+
+[[Personal Github](https://github.com/ferusel)]
+[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/ferusel)]
+
+### Bryan Lim Jing Xiang
+
+<img src="docs/images/bryanljx.png" width="200px">
+
+[[Personal Github](https://github.com/bryanljx)]
+[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/bryanljx)]
+
+### Richard Dominick
+
+<img src="docs/images/richdom2185.png" width="200px">
+
+[[Personal Github](https://github.com/RichDom2185)]
+[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/richdom2185)]
+
+### Tan Wei Lie Eugene
+
+<img src="docs/images/eugenetanwl3881.png" width="200px">
+
+[[Personal Github](https://github.com/eugenetanwl3881)]
+[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/eugenetanwl3881)]
+
+### Tan Yi Xian
+
+<img src="docs/images/yixiann.png" width="200px">
+
+[[Personal Github](https://github.com/yixiann)]
+[[Project Portfolio Page](https://ay2223s1-cs2103t-w16-2.github.io/tp/team/yixiann)]
+
+## Acknowledgements
+
+<!-- TODO: Check that this matches {{ site.data.foodrem.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

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.foodrem.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'foodrem.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

cli-test/linkchecker/.gitignore

@@ -0,0 +1 @@
+node_modules