[AY1920S1-CS2113-T13-1] ArchDuke

.gitignore

@@ -1,3 +1,11 @@
+# Configuration Files in saves
+/src/main/saves/
+./savedProjects.json
+savedProjects.json
+
+# Logs file to ingore
+/logs/*
+
 # IDEA files
 /.idea/
 /out/

.travis.yml

@@ -0,0 +1,11 @@
+language: java
+jdk: oraclejdk11
+
+before_install:
+  - chmod +x gradlew
+
+script:
+  - ./gradlew clean checkstyleMain checkstyleTest test
+
+after_success:
+  - ./gradlew jacocoTestReport coveralls

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 AY1920S1-CS2113-T13-1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,28 @@
-# Setting up
+[![Build Status](https://travis-ci.org/AY1920S1-CS2113-T13-1/main.svg?branch=master)](https://travis-ci.org/AY1920S1-CS2113-T13-1/main)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7d04f3f11b98408999c532f54b787d37)](https://www.codacy.com/manual/Lucria/main?utm_source=github.com&utm_medium=referral&utm_content=AY1920S1-CS2113-T13-1/main&utm_campaign=Badge_Grade)
+[![Coverage Status](https://coveralls.io/repos/github/AY1920S1-CS2113-T13-1/main/badge.svg?branch=master)](https://coveralls.io/github/AY1920S1-CS2113-T13-1/main?branch=master)
+
+# ArchDuke - A CLI Project Manager with Kanban board
+**Done by:**
+  * Sean
+  * Abhishek
+  * Dillen
+  * Cynthia
+  * Jerry
+
+## Introduction
+* ArchDuke is a desktop Project Manager application. It has a GUI for better visualisation of the Kanban board and tasks
+, but most of the user interactions will happen using a Command Line Interface (CLI).
+* The Kanban board will also be printed onto command line for users that favour the usage of a CLI interface compared
+ to a GUI.
+
+# Table of Contents
+* [Setting Up](#setting-up)
+* [Usage](#usage)
+* [Acknowledgements](#acknowledgements)
+* [License](#license)
+
+## Setting up
 
 **Prerequisites**
 
@@ -8,32 +32,47 @@
 
 **Importing the project into IntelliJ**
 
-1. Open IntelliJ (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project dialog first).
-1. Set up the correct JDK version.
-   * Click `Configure` > `Structure for new Projects` (in older versions of Intellij:`Configure` > `Project Defaults` > `Project Structure`).
-   * If JDK 11 is listed in the drop down, select it. If it is not, click `New...` and select the directory where you installed JDK 11.
-   * Click `OK`.
-1. Click `Import Project`.
-1. Locate the project directory and click `OK`.
-1. Select `Create project from existing sources` and click `Next`.
-1. Rename the project if you want. Click `Next`.
-1. Ensure that your src folder is checked. Keep clicking `Next`.
-1. Click `Finish`.
-
-# Tutorials 
-
-Duke Increment | Tutorial
----------------|---------------
-`A-Gradle` | [Gradle Tutorial](tutorials/gradleTutorial.md)
-`A-TextUiTesting` | [Text UI Testing Tutorial](tutorials/textUiTestingTutorial.md)
-`Level-10` | JavaFX tutorials:<br>→ [Part 1: Introduction to JavaFX][fx1]<br>→ [Part 2: Creating a GUI for Duke][fx2]<br>→ [Part 3: Interacting with the user][fx3]<br>→ [Part 4: Introduction to FXML][fx4]
+1.  Open IntelliJ (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project dialog first).
+
+2.  Set up the correct JDK version.
+    * Click `Configure` > `Structure for new Projects` (in older versions of Intellij:`Configure` > `Project Defaults` > `Project Structure`).
+    * If JDK 11 is listed in the drop down, select it. If it is not, click `New...` and select the directory where you installed JDK 11.
+    * Click `OK`.
+3.  Click `Import Project`.
+
+4.  Locate the project directory and click `OK`.
+
+5.  Select `Create project from existing sources` and click `Next`.
+
+6.  Rename the project if you want. Click `Next`.
+
+7.  Ensure that your src folder is checked. Keep clicking `Next`.
+
+8.  Click `Finish`.
+
+## Tutorials 
+
+|Duke Increment   |Tutorial                                                                                                                                                                                       |
+|---------------  |---------------                                                                                                                                                                                |
+|`Level-10`       |JavaFX tutorials:<br>→ [Part 1: Introduction to JavaFX][fx1]<br>→ [Part 2: Creating a GUI for Duke][fx2]<br>→ [Part 3: Interacting with the user][fx3]<br>→ [Part 4: Introduction to FXML][fx4]|
 
 [fx1]: <tutorials/javaFxTutorialPart1.md>
 [fx2]: <tutorials/javaFxTutorialPart2.md>
 [fx3]: <tutorials/javaFxTutorialPart3.md>
 [fx4]: <tutorials/javaFxTutorialPart4.md>
 
-# Feedback, Bug Reports
+## Usage
+You can refer to our user guide at this link:
+*   [User Guide](./docs/UserGuide.adoc)
+
+For more advanced users and developers, do refer to our Developer Guide:
+*   [Developer Guide](./docs/DeveloperGuide.adoc)
+
+## Acknowledgements 
+  * This application was written as submission for our Team project under the module CS2113 Software Engineering and
+ Object-Oriented Programming
+
+  * Libraries used in this project: Natty?, GSON?, some Text to Speech?, JavaFX?, JUnit5
 
-* If you have feedback or bug reports, please post in [se-edu/duke issue tracker](https://github.com/se-edu/duke/issues).
-* We welcome pull requests too.
+## License
+MIT Licensesd

build.gradle

@@ -0,0 +1,97 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+    id 'org.openjfx.javafxplugin' version '0.0.7'
+    id 'jacoco'
+    id 'com.github.kt3k.coveralls' version '2.8.4'
+}
+
+checkstyle {
+    toolVersion = '8.23'
+}
+
+shadowJar {
+    archiveBaseName = "duke"
+    archiveVersion = "0.1.3"
+    archiveClassifier = null
+    archiveAppendix = null
+}
+
+clean {
+    delete 'savedProjects.json'
+    delete 'logs'
+}
+
+jacoco {
+    toolVersion = "0.8.4"
+}
+
+jacocoTestReport {
+    reports {
+        xml.enabled true
+        csv.enabled true
+    }
+}
+
+coveralls {
+    jacocoReportPath 'build/reports/jacoco/test/jacocoTestReport.xml'
+}
+
+test {
+    useJUnitPlatform()
+    jacoco {
+        destinationFile = new File("${buildDir}/jacoco/test.exec")
+    }
+}
+
+group 'seedu.duke'
+version '0.1.3'
+
+repositories {
+    mavenCentral()
+}
+
+application {
+    // Change this to your main class.
+    mainClassName = "launcher.Duke"
+}
+
+javafx {
+    version = "11.0.2"
+    modules = [ 'javafx.controls', 'javafx.fxml' ]
+}
+
+run {
+    standardInput = System.in
+}
+
+javafx {
+    version = "11.0.2"
+    modules = [ 'javafx.controls', 'javafx.fxml' ]
+}
+
+dependencies {
+    String javaFxVersion = '11'
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.5.0'
+    implementation 'com.google.code.gson:gson:2.8.6'
+
+    compile group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.12.1'
+//    compile group:"com.fasterxml.jackson.core", name:"jackson-core", version:'2.4.2'
+//    compile group:"com.fasterxml.jackson.core", name:"jackson-databind", version:'2.4.2'
+//    compile group:"com.fasterxml.jackson.core", name:"jackson-annotations", version:'2.4.2'
+
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
+}