[CS2103T-W12-4] CookBuddy

.github/ISSUE_TEMPLATE/add-a-user-story.md

@@ -0,0 +1,12 @@
+---
+name: Add a User Story
+about: This template helps add a user story as an issue to be tracked.
+title: As a user, I can ...
+labels: type.Story
+assignees: ''
+
+---
+
+... so that ...
+
+Command: `...`

.gitignore

@@ -2,6 +2,7 @@
 /.gradle/
 /build/
 src/main/resources/docs/
+/bin/
 
 # IDEA files
 /.idea/
@@ -19,3 +20,10 @@ src/test/data/sandbox/
 
 # MacOS custom attributes files created by Finder
 .DS_Store
+
+# VS Code files
+.project
+.settings/org.eclipse.buildship.core.prefs
+.vscode/settings.json
+.classpath
+.settings/org.eclipse.jdt.core.prefs

README.adoc

@@ -1,11 +1,10 @@
-= Address Book (Level 3)
-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-CS2103T-W12-4/main[image:https://travis-ci.org/AY1920S2-CS2103T-W12-4/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/AdarshChugani/main[image:https://ci.appveyor.com/api/projects/status/coce69u02f8j3qte?svg=true[Build Status]]
+https://coveralls.io/github/AY1920S2-CS2103T-W12-4/main?branch=master[image:https://coveralls.io/repos/github/AY1920S2-CS2103T-W12-4/main/badge.svg?branch=master[Coverage Status]]
+https://app.codacy.com/gh/AY1920S2-CS2103T-W12-4/main?utm_source=github.com&utm_medium=referral&utm_content=AY1920S2-CS2103T-W12-4/main&utm_campaign=Badge_Grade_Dashboard[image:https://api.codacy.com/project/badge/Grade/26ab505f4302490cb6160c093889381c[Code Quality]]
 
+= CookBuddy Recipe Manager
+ifdef::env-github,env-browser[:relfileprefix: docs/]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,22 +14,22 @@ 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.
+* CookBuddy Recipe Manager is a desktop application for managing recipes.
+* It has a Graphical User Interface (GUI) but most of the user interactions happen through a Command Line Interface (CLI).
+* CookBuddy is designed primarily for advanced computer users who prefer typing over using a mouse.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
-* 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_.
+* This project has been adapted from AddressBook-Level3 sample application created by the SE-EDU initiative at https://se-education.org
+* Some parts of CookBuddy 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]
 
 == Licence : link:LICENSE[MIT]

build.gradle

@@ -15,7 +15,7 @@ plugins {
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.Main'
+mainClassName = 'cookbuddy.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -27,6 +27,7 @@ repositories {
 
 checkstyle {
     toolVersion = '8.1'
+    // ignoreFailures = true;
 }
 
 jacocoTestReport {
@@ -37,10 +38,6 @@ jacocoTestReport {
     }
 }
 
-test {
-    useJUnitPlatform()
-}
-
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
@@ -64,10 +61,12 @@ dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    implementation group: 'org.jfxtras', name: 'jmetro', version: '11.6.9'
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'CookBuddy.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -98,6 +97,8 @@ tasks.coveralls {
 }
 
 test {
+    useJUnitPlatform()
+    ignoreFailures(true)
     testLogging {
         events TestLogEvent.FAILED, TestLogEvent.SKIPPED
 
@@ -133,8 +134,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': 'CookBuddy',
+        'site-githuburl': 'https://github.com/AY1920S2-CS2103T-W12-4/main/',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 
@@ -153,3 +154,4 @@ task copyStylesheets(type: Copy) {
 asciidoctor.dependsOn copyStylesheets
 
 defaultTasks 'clean', 'test', 'coverage', 'asciidoctor'
+//defaultTasks 'clean', 'test', 'asciidoctor'

config/checkstyle/suppressions.xml

@@ -6,4 +6,5 @@
 
 <suppressions>
   <suppress checks="JavadocType" files=".*Test\.java"/>
+  <suppress checks="AbbreviationAsWordInName|MemberName" files="ImageUtil.java"/>
 </suppressions>

desktop.ini

@@ -0,0 +1,6 @@
+[.ShellClassInfo]
+IconResource=C:\Windows\System32\SHELL32.dll,111
+[ViewState]
+Mode=
+Vid=
+FolderType=Generic

docs/AboutUs.adoc

@@ -4,53 +4,53 @@
 :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} +
+CookBuddy - This recipe managing application was developed by the https://github.com/AY1920S2-CS2103T-W12-4/main[AY1920S2-CS2103T-W12-4] 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>>]
+=== Adarsh Mohandas Chugani
+image::adarshchugani.png[width="150", align="left"]
+{empty}[https://github.com/AdarshChugani[github]] [<<adarshchugani#, portfolio>>]
 
-Role: Project Advisor
+Role: Team Lead +
+Responsibilities: UI
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+'''
 
-Role: Team Lead +
-Responsibilities: UI
+=== Kevin Sum
+image::kevinswk94.png[width="150", align="left"]
+{empty}[https://github.com/kevinswk94[github]] [<<kevinswk94#, portfolio>>]
 
-'''
+Role: Developer +
+Responsibilities: Dev Ops
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+'''
+=== Qi Mingsi
+image::e0316059.png[width="150", align="left"]
+{empty}[http://github.com/e0316059[github]] [<<e0316059#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: UI
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Sharadh Rajaraman
+image::sharadhr.png[width="150", align="left"]
+{empty}[http://github.com/sharadhr[github]] [<<sharadhr#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Documentation
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Zain Alam
+image::muhd97.png[width="150", align="left"]
+{empty}[https://github.com/muhd97[github]] [<<muhd97#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: Data
 
-'''

docs/ContactUs.adoc

@@ -2,6 +2,12 @@
 :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-CS2103T-W12-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 `damith [at] comp.nus.edu.sg`
+* *Email us* : You can also reach us at:
+** Adarsh: `[email protected]`
+** Kevin: `[email protected]`
+** Mingsi: `[email protected]`
+** Sharadh: `[email protected]`
+** Zain: `[email protected]`
+

docs/DevOps.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Dev Ops
+= CookBuddy - 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-CS2103T-W12-4/main/tree/master
 
 == Build Automation
 
@@ -41,7 +41,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, *CookBuddy* 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)