nus-cs2103-AY1920S2 · NicholasCF · Mar 31, 2020 · Mar 31, 2020 · Mar 31, 2020 · Mar 31, 2020
diff --git a/.gitignore b/.gitignore
@@ -6,7 +6,7 @@ src/main/resources/docs/
 # IDEA files
 /.idea/
 /out/
-/*.iml
+**/*.iml
 
 # Storage/log files
 /data/
@@ -19,3 +19,8 @@ src/test/data/sandbox/
 
 # MacOS custom attributes files created by Finder
 .DS_Store
+
+# Custom Windows / Shell scripts
+*.bat
+
+
diff --git a/LICENSE b/LICENSE
diff --git a/README.adoc b/README.adoc
@@ -1,10 +1,9 @@
-= Address Book (Level 3)
+= Inventory Manager
 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://travis-ci.org/AY1920S2-CS2103-W14-2/main[image:https://travis-ci.org/AY1920S2-CS2103-W14-2/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/CS2103-W14-2/main[image:https://ci.appveyor.com/api/projects/status/rlr0xji2vhij1016?svg=true[Build status]]
+https://coveralls.io/github/AY1920S2-CS2103-W14-2/main?branch=master[image:https://coveralls.io/repos/github/AY1920S2-CS2103-W14-2/main/badge.svg?branch=master[Coverage Status]]
 
 
 ifdef::env-github[]
@@ -15,15 +14,20 @@ 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.
+* This is a desktop Inventory Manager application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
+* It facilitates easily management of stocks, which includes:
+    ** warning when supplies are
+    low
+    ** easy sourcing of suppliers for selected goods
+    ** expiry management
+    ** seamless updating of inventory upon procurement and sales transactions
+* This application is optimized for fast-typists. If you are comfortable with the keyboard,
+Inventory Manager will be a joy to use!
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
@@ -32,5 +36,6 @@ endif::[]
 * 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]
+* This project is an extension of AddressBook-Level3 project codebase created by https://se-education.org[SE-EDU initiative]
 
 == Licence : link:LICENSE[MIT]
diff --git a/_config.yml b/_config.yml
diff --git a/appveyor.yml b/appveyor.yml
diff --git a/build.gradle b/build.gradle
@@ -67,7 +67,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'inventorymanager.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -133,8 +133,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': 'InventoryManager',
+        'site-githuburl': 'https://github.com/AY1920S2-CS2103-W14-2/main',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 

diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
diff --git a/config/checkstyle/suppressions.xml b/config/checkstyle/suppressions.xml
diff --git a/copyright.txt b/copyright.txt
@@ -1,8 +1,7 @@
 Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
 
-Copyright by Susumu Yoshida - http://www.mcdodesign.com/
-- address_book_32.png
-- AddressApp.ico
+Copyright by Iconfactory - https://iconfactory.com/
+- inventory_manager_32.png
 
 Copyright by Jan Jan Kovařík - http://glyphicons.com/
 - calendar.png

diff --git a/docs/AboutUs.adoc b/docs/AboutUs.adoc
@@ -4,53 +4,42 @@
 :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} +
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== 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>>]
+=== Nicholas Cristian Fernando
+image::nicholascf.png[width="150", align="left"]
+{empty}[https://github.com/NicholasCF[github]] [<<nicholascf#, portfolio>>]
 
-Role: Project Advisor
-
-'''
-
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
-
-Role: Team Lead +
-Responsibilities: UI
+Role: Developer +
+Responsibilities: Suppliers
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Pang Jia Da
+image::pangjiada.png[width="150", align="left"]
+{empty}[https://github.com/PangJiaDa[github]] [<<pangjiada#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: Transactions
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Fang Shao Hua
+image::fangshaohua94.png[width="150", align="left"]
+{empty}[https://github.com/FangShaoHua94[github]] [<<fangshaohua94#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Inventory
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Liu Chao
+image::liuchao93.png[width="150", align="left"]
+{empty}[https://github.com/LiuChao93[github]] [<<liuchao93#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: Suppliers
 
 '''
diff --git a/docs/ContactUs.adoc b/docs/ContactUs.adoc
@@ -2,6 +2,10 @@
 :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/AY1920S2-CS2103-W14-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
+** `[email protected]`
+** `[email protected]`
+** `[email protected]`
+** `[email protected]`
diff --git a/docs/DevOps.adoc b/docs/DevOps.adoc
@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Dev Ops
+= InventoryManager - 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/AY1920S2-CS2103-W14-2/main/tree/master
 
 == Build Automation
 
@@ -26,10 +26,6 @@ We use https://travis-ci.org/[Travis CI] and https://www.appveyor.com/[AppVeyor]
 
 We use https://coveralls.io/[Coveralls] to track the code coverage of our projects. See <<UsingCoveralls#, UsingCoveralls.adoc>> for more details.
 
-== Documentation Previews
-
-When a pull request has changes to asciidoc files, you can use https://www.netlify.com/[Netlify] to see a preview of how the HTML version of those asciidoc files will look like when the pull request is merged. See <<UsingNetlify#, UsingNetlify.adoc>> for more details.
-
 == Making a Release
 
 Here are the steps to create a new release.
@@ -41,7 +37,7 @@ Here are the steps to create a new release.
 
 == Managing Dependencies
 
-A project often depends on third-party libraries. For example, Address Book depends on the https://github.com/FasterXML/jackson[Jackson library] for JSON parsing. Managing these _dependencies_ can be automated using Gradle. For example, Gradle can download the dependencies automatically, which is better than these alternatives:
+A project often depends on third-party libraries. For example, InventoryManager depends on the https://github.com/FasterXML/jackson[Jackson library] for JSON parsing. Managing these _dependencies_ can be automated using Gradle. For example, Gradle can download the dependencies automatically, which is better than these alternatives:
 
 [loweralpha]
 . Include those libraries in the repo (this bloats the repo size)