[CS2103T-T11-2] Dukemon

README.adoc

@@ -1,11 +1,9 @@
-= Address Book (Level 3)
+= Dukemon
 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://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+https://travis-ci.org/AY1920S1-CS2103T-T11-2/main[image:https://travis-ci.org/AY1920S1-CS2103T-T11-2/main.svg?branch=master[Build Status]]
+https://coveralls.io/github/AY1920S1-CS2103T-T11-2/main?branch=master[image:https://coveralls.io/repos/AY1920S1-CS2103T-T11-2/main/badge.svg?branch=master[Coverage Status]]
+https://www.codacy.com/manual/kohyida1997/main?utm_source=github.com&utm_medium=referral&utm_content=AY1920S1-CS2103T-T11-2/main&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/cd0b23e15b6a4fbca82036bdf5952fb1[Codacy Badge]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,20 +13,24 @@ 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.
+* Dukemon is a desktop Flashcard style program designed to help YOU revise your work. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
+* It is a program intended to help *troubled students* revise definitions and important keywords that they encounter in their studies.
+* Subjects like Biology, Physics and Chemistry are especially compatible with our program. You will be able to create and save your own flashcards and datasets to test yourself.
+* The flow of the program is simple - the question appears and you type in the matching answer.
+* There are different game modes (Timed vs. Non-Timed, Hints vs. No-Hints) and difficulties that you can configure to challenge yourself.
+* You will also be able to keep track of your statistics and progress.
+* *SUPERCHARGE YOUR LEARNING NOW* and use *Dukemon* !
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
+* Adapted from source code of the AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
 * 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]

docs/AboutUs.adoc

@@ -4,53 +4,60 @@
 :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.}_ +
-{empty} +
+Dukemon was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
-== Project Team
+== CS2103T-T11-2
 
-=== 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>>]
+=== James Pang
+image::jamessspanggg.png[width="150", align="left"]
+{empty}[http://github.com/jamessspanggg[homepage]] [https://github.com/jamessspanggg[github]] [<<jamessspanggg#, portfolio>>]
 
-Role: Project Advisor
+Role: Project Advisor + TA
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Chen Hui
+image::chrischenhui.png[width="150", align="left"]
+{empty}[http://github.com/chrischenhui[github]] [<<chrischenhui#, portfolio>>]
 
 Role: Team Lead +
-Responsibilities: UI
+Responsibilities: UI + Game Logic
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Koh Yi Da
+image::kohyida1997.png[width="150", align="left"]
+{empty}[http://github.com/kohyida1997[github]] [<<kohyida1997#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: Game + Timer + Threading
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Sree Subbash
+image::sreesubbash.png[width="150", align="left"]
+{empty}[http://github.com/sreesubbash[github]] [<<sreesubbash#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Dev Ops + Game Logic
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Jason Sathya Citro
+image::jascxx.png[width="150", align="left"]
+{empty}[http://github.com/jascxx[github]] [<<jascxx#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: UI + Data
+
+'''
+
+=== Paul Tho
+image::dragontho.png[width="150", align="left"]
+{empty}[http://github.com/dragontho[github]] [<<dragontho#, portfolio>>]
+
+Role: Developer +
+Responsibilities: UI + Data
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,11 @@
 :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/AY1920S1-CS2103T-T11-2/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
 * *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 +
+[email protected] +
+[email protected] +
+[email protected] +
+[email protected] +
+[email protected]

docs/DeveloperGuide.adoc

@@ -279,13 +279,12 @@ Refer to the guide <<DevOps#, here>>.
 
 *Target user profile*:
 
-* has a need to manage a significant number of contacts
-* prefer desktop apps over other types
+* wants to learn new English words or definitions
 * can type fast
-* prefers typing over mouse input
+* enjoys games
 * is reasonably comfortable using CLI apps
 
-*Value proposition*: manage contacts faster than a typical mouse/GUI driven app
+*Value proposition*: gamify learning experiences
 
 [appendix]
 == User Stories
@@ -295,17 +294,58 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 [width="59%",cols="22%,<23%,<25%,<30%",options="header",]
 |=======================================================================
 |Priority |As a ... |I want to ... |So that I can...
-|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App
 
-|`* * *` |user |add a new person |
+|`* * *` |teacher |add, edit, and delete questions in the word banks |make corrections on what my students are supposed to learn
 
-|`* * *` |user |delete a person |remove entries that I no longer need
+|`* * *` |teacher |give customised word banks and definitions |can let my students practice specific problems.
 
-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+|`* * *` |user |list all my word banks |
+
+|`* * *` |user |give titles to word banks |recognise them better
+
+|`* * *` |user |delete word banks |free up some memory when I don’t need it anymore
+
+|`* * *` |user |see the content of the word bank |study beforehand/make changes
+
+|`* * *` |young student |trivia questions to be gamified |enjoy the process
+
+|`* * *` |student |create my own question banks |tailor fit to my learning
+
+|`* * *` |computer science student |have a manual of the commands available |refer to them when I am lost
+
+|`* *` |frequent user |easily access my most recently attempted question sets |can quickly resume my revision
+
+|`* *` |studious student |set and complete goals |have something to work towards
+
+|`* *` |student |see my test statistics |track my progress/improvement
+
+|`* *` |student |choose different kinds of time constraints |can simulate exam conditions
+
+|`* *` |student |categorise my question sets |easily look for relevant materials
+
+|`* *` |student |mark question sets as important/urgent |know how to prioritise my revision
+
+|`* *` |module coordinator |export lessons |send to their students
+
+|`* *` |student |share and compare my results with my classmates |know where I stand
+
+|`* *` |student |partition the trivia |attempt questions that I'm comfortable with
+
+|`* *` |weak student |have the option to see hints |won’t get stuck all the time
+
+|`* *` |computer science student |practise typing bash commands into the CLI |strengthen my bash skills
+
+|`* *` |teacher |export statistics |can compare performance across different students
+
+|`*` |computer science student |customize my “terminal” |changing themes/ background/ font size/ font colour, so that I feel comfortable working on it
+
+|`*` |teacher |protect tests with passwords |let my students do them in lessons together when password is released
+
+|`*` |teacher |protect the files |doesn't get tampered when distributing to students
+
+|`*` |student |have smaller sized files |have more space on my computer
 
-|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
 
-|`*` |user with many persons in the address book |sort persons by name |locate a person easily
 |=======================================================================
 
 _{More to be added}_
@@ -347,8 +387,8 @@ _{More to be added}_
 == Non Functional Requirements
 
 .  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed.
-.  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
 .  A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
+.  Users can export and import their <<word-bank,word banks>> or statistics.
 
 _{More to be added}_
 
@@ -361,6 +401,9 @@ Windows, Linux, Unix, OS-X
 [[private-contact-detail]] Private contact detail::
 A contact detail that is not meant to be shared with others
 
+[[word-bank]] Word Bank::
+A list of word-description pair that either the user can create himself or import from.
+
 [appendix]
 == Product Survey