[AY1920S1-CS2113T-W13-1] Coach Manager

.gitignore

@@ -11,4 +11,4 @@ src/main/resources/docs/
 # MacOS custom attributes files created by Finder
 .DS_Store
 *.iml
-bin/
+bin/

.travis.yml

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

README.md

@@ -1,39 +1,38 @@
-# Setting up
+[![Build Status](https://travis-ci.org/AY1920S1-CS2113T-W13-1/main.svg?branch=master)](https://travis-ci.org/AY1920S1-CS2113T-W13-1/main)
+# Coach Manager
+By: `W13-1`   Since: `16 September 2019`
 
-**Prerequisites**
+## Introduction
+Coach Manager is an app designed for use by busy sports trainers in charge of multiple classes and many students. The app is optimized to keep track of the classes and students a trainer is in charge of. The schedule and lessons to be taught can be viewed by the trainer, and training plans can even be adjusted as per requirements. In addition, the planner helps the trainer track the progress of the students by making comparisons between their current standards to past records or personal best.
 
-* JDK 11
-* Recommended: IntelliJ IDE
-* Fork this repo to your GitHub account and clone the fork to your computer
+## User Interface
+![UI Example](https://github.com/AY1920S1-CS2113T-W13-1/main/blob/master/docs/images/Ui.png)
 
-**Importing the project into IntelliJ**
+## Features 
 
-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`.
+### Feature 1: Training Schedule
+This feature allows the trainer to add or remove training days to a training schedule. The manager may select to view the schedule by the day/week/month. After creating a training day, they will be able to add students to the lesson individually, or by pre-arranged groups.
 
-# 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]
+### Feature 2: Training Session Sub-schedule
+Trainer is able to view his daily schedule. Training programmes can be edited for the day and special goals of the day can be viewed to see which students require special attention. A reflection for the day can be keep stored in the app, to allow trainers to reflect on any improvements seen in students, or if any students require assistance for the near future.
 
-[fx1]: <tutorials/javaFxTutorialPart1.md>
-[fx2]: <tutorials/javaFxTutorialPart2.md>
-[fx3]: <tutorials/javaFxTutorialPart3.md>
-[fx4]: <tutorials/javaFxTutorialPart4.md>
 
-# Feedback, Bug Reports
+### Feature 3: Manage Students
+Trainers are able to view student details such as age, NRIC, and emergency contacts, as well as past achievements. In addition, trainer comments like attendance, strengths and weaknesses, personality and personal best of students in the training course can be maintained.  This information can facilitate the planning of a more suitable training programme for every student.
 
-* 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.
+
+### Feature 4: Training Circuits 
+The trainer is able to create general training regimes for his classes that are often used. He may create multiple training regimes which can be added to specific training days, and each training has a level of intensity tied to it. He may view specific regimes, or even all of the regimes in a list format neatly and may be sorted based on the level of intensity. Training regimes can also be edited to adjust certain activities, or remove them to better suit the needs of the students.
+
+
+### Feature 5: Menu
+The trainer is able to navigate across the different features of the app easily. He may also see the list of commands for each feature menu.
+
+
+## Site Map
+* [About Us](https://github.com/AY1920S1-CS2113T-W13-1/main/blob/master/docs/AboutUs.adoc)
+
+* [User Document](https://github.com/AY1920S1-CS2113T-W13-1/main/blob/master/docs/UserGuide.adoc)
+
+* [Developer Guide](https://github.com/AY1920S1-CS2113T-W13-1/main/blob/master/docs/DeveloperGuide.adoc)

build.gradle

@@ -0,0 +1,59 @@
+plugins {
+    id 'application'
+    id 'checkstyle'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+    id 'org.openjfx.javafxplugin' version '0.0.7'
+}
+
+shadowJar {
+    archiveBaseName = "CoachManager"
+    archiveVersion = "0.1.4"
+    archiveClassifier = null
+    archiveAppendix = null
+}
+
+checkstyle {
+    toolVersion = '8.23'
+}
+
+javafx {
+    version = "11.0.2"
+    modules = [ 'javafx.controls', 'javafx.fxml' ]
+}
+
+dependencies {
+    String javaFxVersion = '11'
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.5.0'
+    compile 'com.googlecode.json-simple:json-simple:1.1.1'
+    compile 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.9.3'
+    compile group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.12.1'
+    implementation 'com.google.code.gson:gson:2.8.6'
+    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()
+}
+
+repositories {
+    mavenCentral()
+}
+
+application {
+    mainClassName = "duke.launcher.Main"
+}
+
+run {
+    standardInput = System.in
+}