[W12-4] FrozenBook

README.adoc

@@ -1,41 +1,46 @@
-= Address Book (Level 4)
+= Drink I/O
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&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]]
+https://https://travis-ci.org/CS2113-AY1819S1-W12-4[image:https://travis-ci.org/CS2113-AY1819S1-W12-4/main.svg?branch=master[Build Status]]
+// https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
+// https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
+// https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&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]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
 endif::[]
 
+ifndef::env-github[]
+image::images/drink_io_logo.png[width="600"]
+endif::[]
+
+== About App
+*[blue]#_Drink I/O_#* is a comprehensive inventory management system targeted at small-scale drink distribution companies that  typically use Microsoft Excel or paper to keep track of their stocks.
+This system will enable employees and managers to keep track of the stocks of various drinks, as well as the profit / revenue earned over time periods.
+This will enable them to stock up on goods in a timely manner and make it easier for them to track their finances.
+
 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.
-* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
-** A more sophisticated GUI that includes a list  panel and an in-built Browser.
-** More test cases, including automated GUI testing.
-** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
+* https://cs2113-ay1819s1-w12-4.github.io/main/AccountantUserGuide.html[Accountant user guide]
+* https://cs2113-ay1819s1-w12-4.github.io/main/ManagerUserGuide.html[Manager user guide]
+* https://cs2113-ay1819s1-w12-4.github.io/main/StockTakerUserGuide.html[Stock taker user guide]
+* https://cs2113-ay1819s1-w12-4.github.io/main/AdminUserGuide.html[Admin user guide]
 
-== Acknowledgements
 
-* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
+== Acknowledgements
+* Original source of code: Addressbook-Level4 project created by SE-EDU initiative at [https://github.com/se-edu]
+* Some parts of this application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
 _Marco Jakob_.
 * Libraries used: https://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]
 
 == Licence : link:LICENSE[MIT]
-

_reposense/config.json

@@ -0,0 +1,25 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "bluein-green",
+      "displayName": "JIN...JIA",
+      "authorNames": ["bluein-green", "Jin Minjia"]
+    },
+    {
+      "githubId": "scottljw",
+      "displayName": "LI ...WEI",
+      "authorNames": ["scottljw", "Li Jiawei", "Scott Lee"]
+    },
+    {
+      "githubId": "Lunastryke",
+      "displayName": "LIM...HAO",
+      "authorNames": ["Lunastryke"]
+    },
+    {
+      "githubId": "liu-tianhang",
+      "displayName": "LIU...ANG",
+      "authorNames": ["liu-tianhang"]
+    }
+  ]
+}

build.gradle

@@ -13,7 +13,13 @@ plugins {
     id 'org.asciidoctor.convert' version '1.5.6'
     id 'application'
 }
-
+//jar {
+//    manifest {
+//        attributes(
+//                'Main-Class': 'seedu.address.MainApp'
+//        )
+//    }
+//}
 if (JavaVersion.current() == JavaVersion.VERSION_1_10
         && System.getProperty('os.name').startsWith('Windows')) {
     logger.warn('''\
@@ -82,7 +88,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'DrinkIO.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -207,9 +213,9 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level4',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
-        'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
+        'site-name': 'Drink I/O',
+        'site-githuburl': 'https://cs2113-ay1819s1-w12-4.github.io/main/',
+        'site-seedu': false,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 
     options['template_dirs'].each {

config/checkstyle/checkstyle.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE module PUBLIC
-    "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
-    "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+        "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
 
 <!--
     This configuration file enforces rules for a modified version of the module's code standard at
@@ -55,11 +55,11 @@
       4. THIRD_PARTY_PACKAGE: defined as com imports
     -->
     <module name="CustomImportOrder">
-        <property name="customImportOrderRules"
-            value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
-        <property name="specialImportsRegExp" value="^org\."/>
-        <property name="thirdPartyPackageRegExp" value="^com\."/>
-        <property name="sortImportsInGroupAlphabetically" value="true"/>
+      <property name="customImportOrderRules"
+                value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
+      <property name="specialImportsRegExp" value="^org\."/>
+      <property name="thirdPartyPackageRegExp" value="^com\."/>
+      <property name="sortImportsInGroupAlphabetically" value="true"/>
     </module>
 
     <!-- Checks for redundant import statements.
@@ -220,7 +220,7 @@
       some other variants which we don't publicized to promote consistency).
       -->
       <property name="reliefPattern"
-       value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
+                value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
     </module>
 
     <module name="MissingSwitchDefault"/>

config/checkstyle/suppressions.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0"?>
 
 <!DOCTYPE suppressions PUBLIC
-"-//Puppy Crawl//DTD Suppressions 1.1//EN"
-"http://checkstyle.sourceforge.net/dtds/suppressions_1_1.dtd">
+        "-//Puppy Crawl//DTD Suppressions 1.1//EN"
+        "http://checkstyle.sourceforge.net/dtds/suppressions_1_1.dtd">
 
 <suppressions>
   <suppress checks="JavadocType" files=".*Test\.java"/>

docs/AboutUs.adoc

@@ -4,53 +4,48 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 4 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.}_ +
+*[blue]#_Drink I/O_#* was developed by Team CS2113-AY1819S1-W12-4. +
 {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>>]
+=== Jin Minjia
+image::bluein-green.png[width="150", align="left"]
+{empty}[http://github.com/bluein-green[github]] [<<bluein-green#, portfolio>>]
 
-Role: Project Advisor
+Role: Developer
 
-'''
-
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
-
-Role: Team Lead +
-Responsibilities: UI
+Responsibilities: Model
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Li Jiawei
+image::scottljw.png[width="150", align="left"]
+{empty}[http://github.com/scottljw[github]] [<<scottljw#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Developer
+
+Responsibilities: Storage
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Lim Xuan Hao
+image::lunastryke.png[width="150", align="left"]
+{empty}[http://github.com/Lunastryke[github]] [<<lunastryke#, portfolio>>]
+
+Role:  Developer
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Documentation, Git Expert
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Liu Tianhang
+image::liu-tianhang.png[width="150", align="left"]
+{empty}[http://github.com/LIU-TIANHANG[github]] [<<liu-tianhang#, portfolio>>]
+
+Role: Developer
 
-Role: Developer +
-Responsibilities: UI
+Responsibilities: Logic, Security
 
 '''