[CS2103T-W17-1] FlashSpeed

.travis.yml

@@ -4,8 +4,9 @@ matrix:
     - jdk: openjdk11
 
 script: >-
-    ./config/travis/run-checks.sh &&
-    ./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
+    ./gradlew clean 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"]
@@ -15,21 +13,59 @@ ifndef::env-github[]
 image::images/Ui.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.
+ifdef::env-github[]
+image::docs/images/Ui2.png[width="600"]
+endif::[]
+
+ifndef::env-github[]
+image::images/Ui2.png[width="600"]
+endif::[]
+
+ifdef::env-github[]
+image::docs/images/Ui3.png[width="600"]
+endif::[]
+
+ifndef::env-github[]
+image::images/Ui3.png[width="600"]
+endif::[]
+
+== 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!
+
+FlashSpeed enhances the revision process by adopting the Space Repetition System (SRS) in its design. Users will be tested more frequently on new words, or words that they have gotten wrong in previous sessions. This system benefits from the psychological spacing effect. SRS has been scientifically proven to increase the rate of learning and memorisation.
+
+By using FlashSpeed, you will learn faster and remember for longer!
+
+// We hope you enjoy using our app. Happy FlashSpeeding!
+
+//* This is a desktop Flashcard 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 a new 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.
+
+== 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

@@ -67,7 +67,8 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    // archiveName = 'addressbook.jar'
+    archiveName = 'flashspeed.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -120,22 +121,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 {
@@ -153,3 +156,4 @@ task copyStylesheets(type: Copy) {
 asciidoctor.dependsOn copyStylesheets
 
 defaultTasks 'clean', 'test', 'coverage', 'asciidoctor'
+

docs/AboutUs.adoc

@@ -11,44 +11,44 @@ We are a team based in the http://www.comp.nus.edu.sg[School of Computing, Natio
 
 == 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]] [<<johndoe#, portfolio>>]
 
 Role: Project Advisor
 
 '''
 
-=== 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]] [<<johndoe#, portfolio>>]
 
 Role: Team Lead +
 Responsibilities: UI
 
 '''
 
-=== 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]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
 Responsibilities: Data
 
 '''
 
-=== 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]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
 Responsibilities: Dev Ops + Threading
 
 '''
 
-=== 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]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
 Responsibilities: UI

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`
+
+
+