[CS2103-F10-2] iFridge

.gitignore

@@ -19,3 +19,4 @@ src/test/data/sandbox/
 
 # MacOS custom attributes files created by Finder
 .DS_Store
+UserGuide.pdf

LICENSE

@@ -2,11 +2,11 @@ MIT License
 
 Copyright (c) 2016 Software Engineering Education - FOSS Resources
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Permission is hereby granted, free of charge, to any food obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
+copies of the Software, and to permit foods to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all

README.adoc

@@ -1,11 +1,8 @@
-= Address Book (Level 3)
+= iFridge
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level3?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level3?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level3&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
-https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+image:https://travis-ci.org/AY1920S1-CS2103-F10-2/main.svg?branch=master["Build Status", link="https://travis-ci.org/AY1920S1-CS2103-F10-2/main"]
+https://coveralls.io/github/AY1920S1-CS2103-F10-2/main?branch=master[image:https://coveralls.io/repos/github/AY1920S1-CS2103-F10-2/main/badge.svg?branch=master[Coverage Status]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,22 +12,25 @@ ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
+* If you want to manage your food items without hassle, iFridge is the application made for you!
+* This application is made for tech savvy individuals to manage the food in their fridge, control Wastage, and create Shopping Lists.
+* This is a desktop application for managing Food in a Fridge. It has a GUI but most of the user interactions happen using a Command Line Interface.
+* With reminders for food expiring soon and periodic feedback about the waste generated, iFridge will make sure you review and minimize waste.
+* You can create template lists (list of items that you would like to have in your fridge at any time).
+* And, with a single command, you can generate a shopping list of items that are in your template list but not yet there in the Fridge!
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
+* Some parts of this application were inspired by https://se-education.org by SE-EDU initiative.
 * Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
 _Marco Jakob_.
-* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5], http://natty.joestelmach.com/[Natty], http://www.jfree.org/jfreechart/[JFreeChart]
 
 == Licence : link:LICENSE[MIT]

build.gradle

@@ -15,7 +15,7 @@ plugins {
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.ifridge.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -64,10 +64,16 @@ dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    // https://mvnrepository.com/artifact/com.joestelmach/natty
+    compile group: 'com.joestelmach', name: 'natty', version: '0.13'
+
+    // https://mvnrepository.com/artifact/org.jfree/jfreechart-fx
+    compile group: 'org.jfree', name: 'jfreechart-fx', version: '1.0.1'
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'iFridge.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -133,8 +139,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level3',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level3',
+        'site-name': 'iFridge',
+        'site-githuburl': 'https://github.com/AY1920S1-CS2103-F10-2/main',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 

docs/AboutUs.adoc

@@ -4,53 +4,52 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 3 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
-{empty} +
+iFridge was developed by the https://AY1920S1-CS2103-F10-2.github.io/docs/Team.html[AY1920S1-CS2103-F10-2] team. +
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
-== Project Team
+== CS2103-F10-2
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
+=== Tie Ying Kathleen
+image::teika97.png[width="150", align="left"]
+{empty}[http://github.com/teika97[github]] [<<teika97#, portfolio>>]
 
-Role: Project Advisor
+Role: Team Lead + Scheduling and tracking
+Responsibilities: In charge of UI
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Kelvin Harris
+image::kelvinnharris.png[width="150", align="left"]
+{empty}[https://github.com/kelvinnharris[github]] [<<kelvinnharris#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Integration +
+Responsibilities: In charge of Model
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Evelyne Juliet
+image::evelynejuliet.png[width="150", align="left"]
+{empty}[https://github.com/evelynejuliet[github]] [<<evelynejuliet#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Code Quality +
+Responsibilities: In charge of Commons
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Zhang Xuan
+image::zhangxuan97.png[width="150", align="left"]
+{empty}[https://github.com/zhangxuan97[github]] [<<zhangxuan97#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Documentation +
+Responsibilities: In charge of Storage
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Manas Vegi
+image::manasvegi.png[width="150", align="left"]
+{empty}[https://github.com/manasvegi[github]] [<<manasvegi#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Role: Testing +
+Responsibilities: In charge of Logic
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,6 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S1-CS2103-F10-2/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
 * *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
+* *Email us* : You can also reach us at `https://github.com/AY1920S1-CS2103-F10-2`

docs/DevOps.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Dev Ops
+= iFridge - Dev Ops
 :site-section: DeveloperGuide
 :toc:
 :toc-title:
@@ -12,7 +12,7 @@ ifdef::env-github[]
 :note-caption: :information_source:
 :warning-caption: :warning:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
+:repoURL: https://github.com/AY1920S1-CS2103-F10-2/main/tree/master
 
 == Build Automation