[AY1920S1-CS2113-F14-4] SpinBox

.gitignore

@@ -12,3 +12,9 @@ src/main/resources/docs/
 .DS_Store
 *.iml
 bin/
+
+#My additions
+/data/*.txt
+/SpinBoxData/*
+!placeholder.txt
+/text-ui-test/*.txt

.travis.yml

@@ -0,0 +1,8 @@
+language: java
+jdk: openjdk11
+
+before_install:
+ - chmod +x gradlew
+
+after_success:
+ - ./gradlew coverage coveralls

README.adoc

@@ -0,0 +1,32 @@
+= SpinBox 
+ifdef::env-github,env-browser[:relfileprefix: docs/]
+
+https://travis-ci.org/AY1920S1-CS2113T-F14-4/main[image:https://travis-ci.org/AY1920S1-CS2113T-F14-4/main.svg?branch=master[Build Status]]
+https://coveralls.io/github/AY1920S1-CS2113T-F14-4/main?branch=master[image:https://coveralls.io/repos/github/AY1920S1-CS2113T-F14-4/main/badge.svg?branch=master[Coverage Status]]
+
+ifdef::env-github[]
+image::docs/images/Ui.png[width="600"]
+endif::[]
+
+ifndef::env-github[]
+image::images/Ui.png[width="600"]
+endif::[]
+
+* This is a desktop application. It is targetted at NUS students who would like a helping hand in managing a busy school life -- from handling deadlines and keeping track of deliverables and important dates, to monitoring module updates and viewing grades breakdown for every module.
+* 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.
+
+
+== Site Map
+
+* https://github.com/AY1920S1-CS2113T-F14-4/main/blob/master/docs/UserGuide.pdf[User Guide]
+* https://github.com/AY1920S1-CS2113T-F14-4/main/blob/master/docs/DeveloperGuide.pdf[Developer Guide]
+* <<AboutUs#, About 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_.
+* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+
+== Licence : link:LICENSE[MIT]

README.md

@@ -1,39 +1,9 @@
-# Setting up
+# SpinBox
 
-**Prerequisites**
+[![Build Status](https://travis-ci.org/AY1920S1-CS2113T-F14-4/main.svg?branch=master)](https://travis-ci.org/AY1920S1-CS2113T-F14-4/main)
 
-* JDK 11
-* Recommended: IntelliJ IDE
-* Fork this repo to your GitHub account and clone the fork to your computer
+![](docs/images/Ui.png)
 
-**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]
-
-[fx1]: <tutorials/javaFxTutorialPart1.md>
-[fx2]: <tutorials/javaFxTutorialPart2.md>
-[fx3]: <tutorials/javaFxTutorialPart3.md>
-[fx4]: <tutorials/javaFxTutorialPart4.md>
-
-# Feedback, Bug Reports
-
-* 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.
+* This is a desktop application. It is targetted at NUS students who would like a helping hand in managing a busy school life -- from handling deadlines and keeping track of deliverables and important dates, to monitoring module updates and viewing grades breakdown for every module.
+* 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.

build.gradle

@@ -0,0 +1,89 @@
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+    id 'jacoco'
+    id 'com.github.kt3k.coveralls' version '2.8.4'
+}
+
+checkstyle {
+    toolVersion = '8.23'
+}
+
+shadowJar {
+    archiveBaseName = "final"
+    archiveVersion = "v1.4"
+    archiveClassifier = null
+    archiveAppendix = null
+}
+
+jacocoTestReport {
+    reports {
+        xml.enabled = true
+        html.enabled = true
+    }
+}
+
+task coverage(type: JacocoReport) {
+    sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
+    classDirectories.from files(sourceSets.main.output)
+    executionData.from files(jacocoTestReport.executionData)
+    afterEvaluate {
+        classDirectories.from 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
+}
+
+group 'seedu.spinbox'
+version '1.1.0'
+
+repositories {
+    mavenCentral()
+}
+
+application {
+    // Change this to your main class.
+    mainClassName = "spinbox.gui.Launcher"
+}
+
+dependencies {
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.5.0'
+    compile group: 'com.joestelmach', name: 'natty', version: '0.6'
+
+    String javaFxVersion = '11'
+    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'
+}
+
+test {
+    useJUnitPlatform()
+}
+
+run {
+    standardInput = System.in
+}