[F09-2] Restaurant Management System

.gitignore

@@ -2,7 +2,7 @@
 *.class
 
 # Default data file
-addressbook.txt
+Rms.txt
 
 # Package Files #
 *.jar
@@ -22,3 +22,4 @@ publish.sh
 .gradle/
 build/
 
+/config.json

.travis.yml

@@ -4,7 +4,7 @@ matrix:
     - jdk: oraclejdk9
 
 script: >-
-    ./gradlew test asciidoctor
+  ./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
 
 deploy:
   skip_cleanup: true

README.adoc

@@ -1,41 +1,29 @@
-= AddressBook (Level 3)
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 ifdef::env-github,env-browser[:imagesDir: docs/images]
 
-https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
-https://www.codacy.com/app/se-edu/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/d4a0954383444a8db8cb26e5f5b7302c[Codacy Badge]]
+https://travis-ci.org/CS2113-AY1819S1-F09-2/main[image:https://travis-ci.org/CS2113-AY1819S1-F09-2/main.svg?branch=master[Build Status]]
+https://app.codacy.com/project/CS2113-AY1819S1-F09-2/main/dashboard[image:https://api.codacy.com/project/badge/Grade/e4ce38384d584d61bc91c56dcdacbd70["Codacy code quality", link="https://www.codacy.com/app/CS2113-AY1819S1-F09-2/main?utm_source=github.com&utm_medium=referral&utm_content=CS2113-AY1819S1-F09-2/main&utm_campaign=Badge_Grade"]]
+https://coveralls.io/github/CS2113-AY1819S1-F09-2/main?branch=master[image:https://coveralls.io/repos/github/CS2113-AY1819S1-F09-2/main/badge.svg?branch=master[Coverage Status]]
 
-image::Ui.png[]
-
-* This is a CLI (Command Line Interface) Address Book application *written in OOP fashion*. It has a very basic GUI.
-* It is a Java sample application intended for students learning Software Engineering while using Java as
-the main programming language.
-* It provides a *reasonably well-written* code example that is *significantly bigger* than what students
-usually write in data structure modules.
-
-*What's different from level 2*
+image::homepage.png[]
 
-* A simple GUI added to replace the Text UI.
-* A `Logic` class added together with a `LogicTest` class.
-* Appendices added to <<DeveloperGuide#, Developer Guide>>
+= https://cs2113-ay1819s1-f09-2.github.io/main/[Welcome to RMS Homepage]
+Restaurant Management System (RMS) promises to increase the quality of your service and enhance your work experience.  The Command Line Interface makes RMS highly efficient as it reduces the number of steps taken to perform a task to just one (or two).  It is your one-stop solution that can be used for serving customers, updating menu as well as storing and tracking important data. In a nutshell, RMS guarantees to be a faster, safer and smarter choice of management for any restaurants and fast food chains.
 
-*Useful Links*
+image::Ui.png[]
 
-* <<UserGuide#, User Guide>>
-* <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
+* This is a Desktop Application for Restaurant Management System. It is making use of Command Line Interface
+* Our primary target audience for RMS are *Restaurants* and *Fast Food Chains*
+* RMS contains support for Build Automation using Gradle and for Continuous Integration using Travis CI, with coverage checks using Coveralls.
 
-== Contributors
+== Who we are
 
-The full list of contributors for se-edu can be found https://se-edu.github.io/Team.html[here].
+* Restaurant Management System was developed by CS2113-AY1819S1-F09-2 team. We are a team based in the School of Computing, National University of Singapore. For further information, visit <<AboutUs#, ABOUT US>> page.
 
 == Acknowledgements
 
-Some parts of this sample application was inspired by the excellent
+* Restaurant Management System was developed based on the souce code of an
+https://github.com/se-edu/addressbook-level3[Address Book] created by
+SE-EDU initiative.
+* Some parts of this sample application was inspired by the excellent
 http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by Marco Jakob
-
-== Contact Us
-
-* *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.
-* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]

_reposense/config.json

@@ -0,0 +1,30 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "AngWM",
+      "displayName": "ANG...ING",
+      "authorNames": ["AngWM", "Wei Ming"]
+    },
+    {
+      "githubId": "kianhong95",
+      "displayName": "LIM...ONG",
+      "authorNames": ["kianhong95", "Lim Kian Hong"]
+    },
+    {
+      "githubId": "px1099",
+      "displayName": "PHA...INH",
+      "authorNames": ["px1099", "Pham Quang Minh"]
+    },
+    {
+      "githubId": "SalsabilTasnia",
+      "displayName": "SAL... MD",
+      "authorNames": ["SalsabilTasnia"]
+    },
+    {
+      "githubId": "kangmingtay",
+      "displayName": "TAY...ING",
+      "authorNames": ["kangmingtay"]
+    }
+  ]
+}

build.gradle

@@ -6,16 +6,36 @@ import org.gradle.api.tasks.testing.logging.TestLogEvent
 
 plugins {
     id 'java'
+    id 'jacoco'
+    id 'checkstyle'
+    id 'com.github.kt3k.coveralls' version '2.4.0'
     id 'org.asciidoctor.convert' version '1.5.6'
+    id 'com.github.johnrengelman.shadow' version '2.0.3'
+    id 'application'
 }
 
+// Specifies the entry point of the application
+mainClassName = 'seedu.addressbook.Main'
+
 sourceCompatibility = JavaVersion.VERSION_1_9
 targetCompatibility = JavaVersion.VERSION_1_9
 
 repositories {
     mavenCentral()
 }
 
+checkstyle {
+    toolVersion = '8.1'
+}
+
+jacocoTestReport {
+    reports {
+        xml.enabled false
+        csv.enabled false
+        html.destination file("${buildDir}/jacocoHtml")
+    }
+}
+
 sourceSets {
     main {
         java {
@@ -41,10 +61,41 @@ dependencies {
     testImplementation group: 'junit', name: 'junit', version: '4.12'
 }
 
+shadowJar {
+    archiveName = 'addressbook.jar'
+
+    destinationDir = file("${buildDir}/jar/")
+}
+
 task wrapper(type: Wrapper) {
     gradleVersion = '4.8.1'
 }
 
+task coverage(type: JacocoReport) {
+    sourceDirectories = files(sourceSets.main.allSource.srcDirs)
+    classDirectories =  files(sourceSets.main.output)
+    executionData = files(jacocoTestReport.executionData)
+    afterEvaluate {
+        classDirectories = files(classDirectories.files.collect {
+            fileTree(dir: it, exclude: ['**/*.jar'])
+        })
+    }
+    reports {
+        html.enabled = true
+        xml.enabled = true
+    }
+}
+
+coveralls {
+    sourceDirs = sourceSets.main.allSource.srcDirs.absolutePath
+    jacocoReportPath = "${buildDir}/reports/jacoco/coverage/coverage.xml"
+}
+
+tasks.coveralls {
+    dependsOn coverage
+    onlyIf { System.env.'CI' }
+}
+
 test {
     testLogging {
         events TestLogEvent.FAILED, TestLogEvent.SKIPPED
@@ -77,9 +128,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-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
+        'site-name': 'Restaurant Management System',
+        'site-githuburl': 'https://github.com/CS2113-AY1819S1-F09-2/main',
     ]
 
     options['template_dirs'].each {
@@ -96,4 +146,4 @@ task copyStylesheets(type: Copy) {
 }
 asciidoctor.dependsOn copyStylesheets
 
-defaultTasks 'clean', 'test', 'asciidoctor'
+defaultTasks 'clean', 'test', 'coverage', 'asciidoctor'