[CS2103T-W17-1] FlashSpeed

.gitignore

@@ -1,7 +1,6 @@
 # Gradle build files
 /.gradle/
 /build/
-src/main/resources/docs/
 
 # IDEA files
 /.idea/

.travis.yml

@@ -4,8 +4,8 @@ matrix:
     - jdk: openjdk11
 
 script: >-
-    ./config/travis/run-checks.sh &&
-    ./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
+      ./config/travis/run-checks.sh &&
+      ./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
 
 deploy:
   skip_cleanup: true

README.adoc

@@ -1,11 +1,9 @@
-= Address Book (Level 3)
+= FlashSpeed
 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-W17-1/main[image:https://travis-ci.org/AY1920S2-CS2103T-W17-1/main.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]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -14,22 +12,49 @@ endif::[]
 ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
+ 
+
+ifdef::env-github[]
+image::docs/images/Ui2.png[width="600"]
+endif::[]
+
+ifndef::env-github[]
+image::images/Ui2.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.
+
+== What is it?
+
+FlashSpeed is a text-based flashcard application specifically designed for university students who are learning a foreign language. University students often have hectic schedules. With this in mind, FlashSpeed was created to allow students to be able to study and revise foreign vocabulary on the fly. With a single command, you can start a quick study session on FlashSpeed whenever!
+
+Keeping, flipping, and tracking physical flashcards can be a pain. FlashSpeed enhances the studying process by having virtual flashcards and a smarter review system. Users will be tested more frequently on flashcards that they had trouble memorizing previously.
+
+By using FlashSpeed, you will learn faster and remember for longer!
+
+== Who is it for?
+
+FlashSpeed is intended for university students reading a foreign language module who need an effective way to memorize a lot of new vocabulary fast and for the long term. It can also be used by students who need to remember a lot of information (e.g. historical dates, definitions, etc.) before an exam.
+
+Of course, anyone who needs a powerful memorization tool can benefit from using FlashSpeed!
 
 == Site Map
 
-* <<UserGuide#, User Guide>>
-* <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
-* <<AboutUs#, About Us>>
-* <<ContactUs#, Contact Us>>
+* https://ay1920s2-cs2103t-w17-1.github.io/main/UserGuide.html[User Guide]
+* https://ay1920s2-cs2103t-w17-1.github.io/main/DeveloperGuide.html[Developer Guide]
+* https://ay1920s2-cs2103t-w17-1.github.io/main/AboutUs.html[About Us]
+* https://ay1920s2-cs2103t-w17-1.github.io/main/ContactUs.html[Contact Us]
+
+//* <<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
+* FlashSpeed is built on top of the AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org.
+* Some parts of the 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]
 

build.gradle

@@ -15,7 +15,7 @@ plugins {
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.Main'
+mainClassName = 'com.flashspeed.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -57,6 +57,12 @@ dependencies {
     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'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'linux'
 
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
@@ -67,7 +73,8 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    // archiveName = 'addressbook.jar'
+    archiveName = 'flashspeed.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -120,22 +127,24 @@ asciidoctor {
     outputDir "${buildDir}/docs"
 
     options = [
-        template_dirs: [file("${sourceDir}/templates")],
+            template_dirs: [file("${sourceDir}/templates")],
     ]
 
     attributes = [
-        linkcss: true,
-        stylesheet: 'gh-pages.css',
-        'source-highlighter': 'coderay',
-        icons: 'font',
-        experimental: true,
-        sectlinks: true,
-        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-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
+            linkcss: true,
+            stylesheet: 'gh-pages.css',
+            'source-highlighter': 'coderay',
+            icons: 'font',
+            experimental: true,
+            sectlinks: true,
+            idprefix: '',  // for compatibility with GitHub preview
+            idseparator: '-',
+            'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
+            // 'site-name': 'AddressBook-Level3',
+            'site-name': 'FlashSpeed',
+            // 'site-githuburl': 'https://github.com/se-edu/addressbook-level3',
+            'site-githuburl': 'https://github.com/AY1920S2-CS2103T-W17-1/main',
+            'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 
     options['template_dirs'].each {

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.}_ +
+FlashSpeed was developed by the https://github.com/AY1920S2-CS2103T-W17-1[CS2103T-W17-1] team. +
 {empty} +
 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>>]
+=== AMIRUL ARDY BIN MOHAMED RASI
+image::amrl.png[width="150", align="left"]
+{empty}[https://github.com/amrl[github]] [<<amrl#, portfolio>>]
 
-Role: Project Advisor
+Role: Technical Lead +
+Responsibilities: User Guide, Deliverables and deadline, Integration, Automated build and test tools
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== CHIEW KOK SENG
+image::kschiew.png[width="150", align="left"]
+{empty}[http://github.com/kschiew[github]] [<<kschiew#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Software Architect +
+Responsibilities: App Architecture, Logic, Storage, Statistics
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== LEONG ZHAN HAO, NICHOLAS
+image::ncslzh.png[width="150", align="left"]
+{empty}[https://github.com/ncslzh[github]] [<<ncslzh#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: DevOps +
+Responsibilities: Developer Guide, Agenda/Issue tracker, Game Algorithm
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== LIAO LIXIN
+image::olixino.png[width="150", align="left"]
+{empty}[http://github.com/oLiXino[github]] [<<olixino#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Play View, Model, Game Component
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== PHAM TRAN TUAN LINH
+image::lacedaemon98.png[width="150", align="left"]
+{empty}[http://github.com/lacedaemon98[github]] [<<lacedaemon98#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Role: Developer, Designer +
+Responsibilities: UI/UX, Visual, Logic
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,14 @@
 :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-W17-1/main/issues[issue tracker] if you noticed bugs or have suggestions on how to make improvement.
 * *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
+** `e0310544 [at] u.nus.edu`
+** `e0309862 [at] u.nus.edu`
+** `e0332767 [at] u.nus.edu`
+** `pham98 [at] u.nus.edu`
+** `lixin11 [at] u.nus.edu`
+
+
+

docs/DevOps.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Dev Ops
+= FlashSpeed - 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-W17-1/main
 
 == Build Automation