[AY1920S1-CS2113T-F10-2] Duke 2.0

.gitignore

@@ -12,3 +12,7 @@ src/main/resources/docs/
 .DS_Store
 *.iml
 bin/
+
+
+# no class files
+*.class

.idea (1)/gradle.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="GradleMigrationSettings" migrationVersion="1" />
+  <component name="GradleSettings">
+    <option name="linkedExternalProjectsSettings">
+      <GradleProjectSettings>
+        <option name="distributionType" value="DEFAULT_WRAPPED" />
+        <option name="externalProjectPath" value="$PROJECT_DIR$" />
+        <option name="gradleJvm" value="11" />
+        <option name="modules">
+          <set>
+            <option value="$PROJECT_DIR$" />
+          </set>
+        </option>
+        <option name="useQualifiedModuleNames" value="true" />
+      </GradleProjectSettings>
+    </option>
+  </component>
+</project>

.idea (1)/misc.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ExternalStorageConfigurationManager" enabled="true" />
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" project-jdk-name="11" project-jdk-type="JavaSDK" />
+</project>

.idea (1)/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

.idea (1)/workspace.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ChangeListManager">
+    <list default="true" id="32e0d890-2356-4679-ad97-55a0f7900531" name="Default Changelist" comment="">
+      <change beforePath="$PROJECT_DIR$/save.txt" beforeDir="false" afterPath="$PROJECT_DIR$/save.txt" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main/resources/view/JavaFX.DialogBox.fxml" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/resources/view/JavaFX.DialogBox.fxml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main/resources/view/JavaFX.MainWindow.fxml" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/resources/view/JavaFX.MainWindow.fxml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/text-ui-test/runtest.bat" beforeDir="false" afterPath="$PROJECT_DIR$/text-ui-test/runtest.bat" afterDir="false" />
+    </list>
+    <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="ExternalProjectsData">
+    <projectState path="$PROJECT_DIR$">
+      <ProjectState />
+    </projectState>
+  </component>
+  <component name="ExternalProjectsManager">
+    <system id="GRADLE">
+      <state>
+        <projects_view>
+          <tree_state>
+            <expand />
+            <select />
+          </tree_state>
+        </projects_view>
+      </state>
+    </system>
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="ProjectId" id="1QP04s2EWdV1gAyLP8gHmpIcNUE" />
+  <component name="RunDashboard">
+    <option name="ruleStates">
+      <list>
+        <RuleState>
+          <option name="name" value="ConfigurationTypeDashboardGroupingRule" />
+        </RuleState>
+        <RuleState>
+          <option name="name" value="StatusDashboardGroupingRule" />
+        </RuleState>
+      </list>
+    </option>
+  </component>
+  <component name="RunManager">
+    <configuration name="JavaFX.Launcher" type="Application" factoryName="Application" temporary="true" nameIsGenerated="true">
+      <option name="MAIN_CLASS_NAME" value="JavaFX.Launcher" />
+      <module name="duke.main" />
+      <method v="2">
+        <option name="Make" enabled="true" />
+      </method>
+    </configuration>
+    <recent_temporary>
+      <list>
+        <item itemvalue="Application.JavaFX.Launcher" />
+      </list>
+    </recent_temporary>
+  </component>
+  <component name="SvnConfiguration">
+    <configuration />
+  </component>
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="32e0d890-2356-4679-ad97-55a0f7900531" name="Default Changelist" comment="" />
+      <created>1567656737368</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1567656737368</updated>
+    </task>
+    <servers />
+  </component>
+  <component name="Vcs.Log.Tabs.Properties">
+    <option name="TAB_STATES">
+      <map>
+        <entry key="MAIN">
+          <value>
+            <State>
+              <option name="COLUMN_ORDER" />
+            </State>
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
+</project>

Git quick guide.txt

@@ -0,0 +1,13 @@
+$ git tag -a v1.4 -m "my version 1.4" //Tags current commit, message is a must
+$ git tag v1.4 //Lightweight tag without message, include checksum after tag name to tag a particular commit
+$ git log --pretty=oneline //Displays all commits and their checksum in a nice format
+$ git tag -a v1.2 9fceb02 -m "my version 1.2" //Tags a particular commit via part of its checksum
+$ git tag -d v1.4 // Deletes a tag
+$ git push origin --tags //Pushes all local tags to remote repo
+
+//Tags case sensitive, important implements outside of levels also need to be tagged
+
+To handle Binary files differing, use:
+git checkout --theirs -- ~/path/to/binary_file
+or 
+git checkout --ours -- ~/path/to/binary_file

README.md

@@ -1,39 +1,47 @@
-# Setting up
+# DEGREES.NUS
 
-**Prerequisites**
+An application developed in Java for prospective applicants to the NUS Faculty of Engineering, who prefer to use a desktop application in order to research on degrees and courses offered by the NUS Faculty of Engineering. 
 
-* JDK 11
-* Recommended: IntelliJ IDE
-* Fork this repo to your GitHub account and clone the fork to your computer
+## Features
+* Scrapes course information from the NUS database
+* Ranking system for courses
+* Display course information and module information
+* Accepts commands for input
+* Task manager to organise faculty events
+* Compares degrees and modules offered
+* Display employment statistics of recent graduates
+* Display recent cohort sizes of each degree 
 
-**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`.
+## Technologies Used
+Project is created with:
+* Java Development Kit 11
+* JavaFX 11 (via Gradle openJFX)
+* Gradle
+* IntelliJ IDEA Community Edition 2019.2.1
 
-# Tutorials 
+## User Guide
 
-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]
+For those who wish to use DEGREES.NUS as-is, please refer to the [User Guide](docs/UserGuide.adoc).
 
-[fx1]: <tutorials/javaFxTutorialPart1.md>
-[fx2]: <tutorials/javaFxTutorialPart2.md>
-[fx3]: <tutorials/javaFxTutorialPart3.md>
-[fx4]: <tutorials/javaFxTutorialPart4.md>
+## For Developers
 
-# Feedback, Bug Reports
+For those who wish to modify the source files for their own project, or just to see how DEGREES.NUS works, refer to [here](docs/DeveloperGuide.adoc).
 
-* 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.
+For a quick guide to modifying gradle for this project, refer to [this guide](docs/GradleUsage.md)
+
+## Status
+
+Currently, this project only has support for 9 degrees in the NUS Faculty of Engineering. We plan to expand and eventually include all degrees and courses available in NUS, and maybe even include other Universities in Singapore. We also plan to add automatic scrapping of course and module information from the NUS database to reduce the workload on the development team and to ensure that the course information is always up-to-date.
+
+## UI Screenshots
+
+![UI](docs/images/Ui.png)
+
+![UI compare](docs/images/compareExample.jpeg)
+
+![UI detail](docs/images/detailExample.jpeg)
+
+## Contributers
+
+[About Us](docs/AboutUs.adoc)

build.gradle

@@ -0,0 +1,65 @@
+plugins {
+    id 'application'
+	id 'com.github.johnrengelman.shadow' version '5.1.0'
+	id 'checkstyle'
+}
+
+checkstyle {
+    toolVersion = '8.23'
+}
+
+dependencies {
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.5.0'
+}
+
+shadowJar {
+    archiveBaseName = "[CS2113T-F10-2][DEGREES.NUS]"
+    archiveVersion = ""
+    archiveClassifier = null
+    archiveAppendix = null
+}
+
+
+version '0.1.0'
+buildDir = '../main'
+File runningDir = new File('../main/bin')
+runningDir.mkdirs()
+tasks.run.workingDir = runningDir
+
+repositories {
+    mavenCentral()
+}
+
+application {
+    // Change this to your main class.
+    mainClassName = "javafx.Launcher"
+	//mainClassName = "Main.Duke"
+}
+
+run {
+    standardInput = System.in
+}
+
+test {
+    useJUnitPlatform()
+}
+
+
+dependencies {
+    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'
+	// https://mvnrepository.com/artifact/org.controlsfx/controlsfx
+	compile group: 'org.controlsfx', name: 'controlsfx', version: '11.0.0'
+    compile group: 'org.jfree', name: 'jfreechart', version: '1.0.19'
+}