[F10-4] MeNUS

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -9,6 +9,7 @@ lib/*
 *.log.*
 *.csv
 config.json
+!_reposense/config.json
 src/test/data/sandbox/
 preferences.json
 .DS_Store

README.adoc

@@ -1,11 +1,14 @@
-= Address Book (Level 4)
+= MeNUS
 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]]
+_Improves the **m**anagement and its **e**fficiency of your restaurants in **NUS**._
+
+https://travis-ci.org/CS2103-AY1819S1-F10-4/main[image:https://travis-ci.org/CS2103-AY1819S1-F10-4/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/AZhiKai/main-j2jk6[image:https://ci.appveyor.com/api/projects/status/5kwkxt5khmfo0q31/branch/master?svg=true[Build status]]
+https://coveralls.io/github/CS2103-AY1819S1-F10-4/main?branch=master[image:https://coveralls.io/repos/github/CS2103-AY1819S1-F10-4/main/badge.svg?branch=master[Coverage Status]]
+https://www.codacy.com/app/AZhiKai/organisation_main?utm_source=github.com&utm_medium=referral&utm_content=CS2103-AY1819S1-F10-4/main&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/299f6df960044215a511a90d281af954[Codacy code quality]]
+https://github.com/CS2103-AY1819S1-F10-4/main/blob/master/LICENSE[image:https://img.shields.io/badge/license-MIT-orange.svg[MIT]]
+https://github.com/CS2103-AY1819S1-F10-4/main[image:https://img.shields.io/badge/team-F10%204-blue.svg[Team F10-4]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,26 +18,30 @@ 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.
+* This is a desktop menu application. It has a GUI but most of the user interactions happen using a CLI (Command Line
+Interface) which is oriented for typist user.
+* The target user group is F&B owners who operate one or more restaurants in NUS. This application aims to improve
+the effectiveness and efficiency of managing their restaurants. Essentially, *MeNUS* is the one and only restaurant
+management system they will ever need.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
+* This application was built based on https://github.com/se-edu/addressbook-level4[Address Book (Level 4)], an
+initiative of the https://se-edu.github.io/Team.html[se-edu] team.
 * 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://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]
+* 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], https://github.com/patrickfav/bcrypt[bcrypt]
+* Free icons: https://www.flaticon.com/authors/smashicons[Smashicons], https://thenounproject.com/term/my-account/219377/[User account icon],
+http://free-icon-rainbow.com/restaurant-menu-free-icon-3/[Menu icon], http://www.iconarchive.com/show/ios7-icons-by-icons8/Food-Bunch-Ingredients-icon.html[Ingredient icon],
+https://icons8.com/icon/pack/city/dotty[Reservation icon], https://mbtskoudsalg.com/explore/sales-icons-png/[Sales icon], http://img.grouponcdn.com/deal/6116wnYU3ci3GdedPMKw/hE-1000x600[Chicken Burger Set photo]
 
 == Licence : link:LICENSE[MIT]

_reposense/config.json

@@ -0,0 +1,30 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "AZhiKai",
+      "displayName": "ANG ZHI KAI",
+      "authorNames": ["AZhiKai", "Ang Zhi Kai"]
+    },
+    {
+      "githubId": "yican95",
+      "displayName": "LEE YI CAN",
+      "authorNames": ["yican95"]
+    },
+    {
+      "githubId": "HyperionNKJ",
+      "displayName": "NEO KAI JUN",
+      "authorNames": ["HyperionNKJ"]
+    },
+    {
+      "githubId": "m4dkip",
+      "displayName": "ONG MING XIAN",
+      "authorNames": ["m4dkip"]
+    },
+    {
+      "githubId": "rebstan97",
+      "displayName": "TAN YING ZI REBECCA",
+      "authorNames": ["rebstan97", "Rebecca"]
+    }
+  ]
+}

build.gradle

@@ -28,7 +28,7 @@ if (JavaVersion.current() == JavaVersion.VERSION_1_10
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.MainApp'
+mainClassName = 'seedu.restaurant.MainApp'
 
 sourceCompatibility = JavaVersion.VERSION_1_9
 targetCompatibility = JavaVersion.VERSION_1_9
@@ -58,6 +58,8 @@ dependencies {
     String testFxVersion = '4.0.12-alpha'
     String jUnitVersion = '5.1.0'
 
+    compile group: 'com.joestelmach', name: 'natty', version: '0.12'
+
     implementation group: 'org.controlsfx', name: 'controlsfx', version: '8.40.11'
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
@@ -66,6 +68,7 @@ dependencies {
     implementation group: 'com.sun.xml.bind', name: 'jaxb-impl', version: '2.3.0'
     implementation group: 'com.sun.xml.bind', name: 'jaxb-core', version: '2.3.0'
     implementation group: 'javax.activation', name: 'activation', version: '1.1.1'
+    implementation group: 'at.favre.lib', name: 'bcrypt', version: '0.5.0'
 
     testImplementation group: 'junit', name: 'junit', version: '4.12'
     testImplementation group: 'org.testfx', name: 'testfx-core', version: testFxVersion, {
@@ -77,12 +80,12 @@ dependencies {
 
     testRuntimeOnly group: 'org.testfx', name: 'testfx-internal-java9', version: testFxVersion
     testRuntimeOnly group: 'org.testfx', name: 'openjfx-monocle', version: 'jdk-9+181'
-    testRuntimeOnly group:'org.junit.vintage', name:'junit-vintage-engine', version: jUnitVersion
+    testRuntimeOnly group: 'org.junit.vintage', name: 'junit-vintage-engine', version: jUnitVersion
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'menus.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -93,7 +96,7 @@ task wrapper(type: Wrapper) {
 
 task coverage(type: JacocoReport) {
     sourceDirectories = files(sourceSets.main.allSource.srcDirs)
-    classDirectories =  files(sourceSets.main.output)
+    classDirectories = files(sourceSets.main.output)
     executionData = files(jacocoTestReport.executionData)
     afterEvaluate {
         classDirectories = files(classDirectories.files.collect {
@@ -157,16 +160,16 @@ test {
         }
 
         if (runNonGuiTests) {
-            test.include 'seedu/address/**'
+            test.include 'seedu/restaurant/**'
         }
 
         if (runGuiTests) {
             test.include 'systemtests/**'
-            test.include 'seedu/address/ui/**'
+            test.include 'seedu/restaurant/ui/**'
         }
 
         if (!runGuiTests) {
-            test.exclude 'seedu/address/ui/**'
+            test.exclude 'seedu/restaurant/ui/**'
         }
     }
 }
@@ -176,10 +179,10 @@ task headless {
         println 'Setting headless mode properties.'
         test {
             systemProperties = [
-                'testfx.robot': 'glass',
-                'testfx.headless': 'true',
-                'prism.order': 'sw',
-                'prism.text': 't2k',
+                    'testfx.robot'   : 'glass',
+                    'testfx.headless': 'true',
+                    'prism.order'    : 'sw',
+                    'prism.text'     : 't2k',
             ]
         }
     }
@@ -194,22 +197,21 @@ asciidoctor {
     outputDir "${buildDir}/docs"
 
     options = [
-        template_dirs: [file("${sourceDir}/templates")],
+            template_dirs: [file("${sourceDir}/templates")],
     ]
 
     attributes = [
-        linkcss: true,
-        stylesheet: 'gh-pages.css',
-        'source-highlighter': 'coderay',
-        icons: 'font',
-        experimental: true,
-        sectlinks: true,
-        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)
+            linkcss             : true,
+            stylesheet          : 'gh-pages.css',
+            'source-highlighter': 'coderay',
+            icons               : 'font',
+            experimental        : true,
+            sectlinks           : true,
+            idprefix            : '',  // for compatibility with GitHub preview
+            idseparator         : '-',
+            'site-root'         : "${sourceDir}",  // must be the same as sourceDir, do not modify
+            'site-name'         : 'MeNUS',
+            'site-githuburl'    : 'https://github.com/CS2103-AY1819S1-F10-4/main',
     ]
 
     options['template_dirs'].each {
@@ -229,7 +231,7 @@ asciidoctor.dependsOn copyStylesheets
 task deployOfflineDocs(type: Copy) {
     into('src/main/resources/docs')
 
-    from ("${asciidoctor.outputDir}/html5") {
+    from("${asciidoctor.outputDir}/html5") {
         include 'stylesheets/*'
         include 'images/*'
         include 'HelpWindow.html'

docs/AboutUs.adoc

@@ -4,53 +4,49 @@
 :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.}_ +
-{empty} +
+MeNUS was developed by the https://CS2103-AY1819S1-F10-4.github.io/main/AboutUs.html[Project Team]
+shown below based on the previous work of the https://se-edu.github.io/Team.html[se-edu] team. +
+
 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>>]
+=== Ang Zhi Kai
+{empty}[http://www.comp.nus.edu.sg/~azhikai[homepage]] [https://github.com/azhikai[github]] [<<azhikai#, portfolio>>]
 
-Role: Project Advisor
+Role: Team Lead, Schedule + Tracking +
+Responsibilities: Model + Storage
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Tan Ying Zi Rebecca
+{empty}[http://github.com/rebstan97[github]] [<<rebstan97#, portfolio>>]
 
-Role: Team Lead +
+Role: Testing + Quality Assurance +
 Responsibilities: UI
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Ong Ming Xian
+{empty}[http://github.com/m4dkip[github]] [<<m4dkip#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Documentation +
+Responsibilities: Logic
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Lee Yi Can
+{empty}[http://github.com/yican95[github]] [<<yican95#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Integration +
+Responsibilities: Logic
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Neo Kai Jun
+{empty}[http://github.com/hyperionnkj[github]] [<<hyperionnkj#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Role: Integration, Code quality, Schedule + Tracking +
+Responsibilities: Storage + UI
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,6 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level4/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`
+* *Bug reports, Suggestions* : Post in our https://github.com/CS2103-AY1819S1-F10-4/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 `azhikai [at] comp.nus.edu.sg`