[CS2103T-T13-2] QuickCache

.gitignore

@@ -13,6 +13,8 @@ src/main/resources/docs/
 /config.json
 /preferences.json
 /*.log.*
+/export/
+/import/
 
 # Test sandbox files
 src/test/data/sandbox/

README.md

@@ -1,14 +1,17 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# QuickCache
+[![Java CI](https://github.com/AY2021S1-CS2103T-T13-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-T13-2/tp/actions)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+This is a desktop application called **QuickCache**. <br>
+**QuickCache** is a flashcard knowledge bank where students can add their content by questions and test themselves afterwards.
+Students can monitor their performance and progress over time using **QuickCache** as well. <br>
+**QuickCache** contains a Graphical User Interface (GUI) but has been optimized to enable user interaction mostly via the Command Line Interface (CLI).
+
+## Site Map
+* [User Guide](https://github.com/AY2021S1-CS2103T-T13-2/tp/blob/master/docs/UserGuide.md)
+* [Developer Guide](https://github.com/AY2021S1-CS2103T-T13-2/tp/blob/master/docs/DeveloperGuide.md)
+* [About Us](https://github.com/AY2021S1-CS2103T-T13-2/tp/blob/master/docs/AboutUs.md)
+
+## Acknowledgements
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'quickcache.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '8.29'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -42,7 +46,7 @@ task coverage(type: JacocoReport) {
 
 dependencies {
     String jUnitVersion = '5.4.0'
-    String javaFxVersion = '11'
+    String javaFxVersion = '11.0.1'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'quickcache.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -3,57 +3,69 @@ layout: page
 title: About Us
 ---
 
+QuickCache was developed by the CS2103T-T13-2 Team (AY2021 Sem 1).
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
-
 ## Project team
 
-### John Doe
+### Josiah
+
+<img src="images/josiahkhoo.png" width="200px">
+
+[[github](https://github.com/josiahkhoo)]
+[[portfolio](team/josiahkhoo.md)]
 
-<img src="images/johndoe.png" width="200px">
+#### Developer and Team Lead
+* Responsible for overall project coordination.
+* In charge of defining, assigning, and tracking project tasks.
+* Ensure project deliverables are done on time and in the right format.
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Francis Hodianto
 
-* Role: Project Advisor
+<img src="images/fh-30.png" width="200px">
 
-### Jane Doe
+[[github](https://github.com/FH-30)]
+[[portfolio](team/fh-30.md)]
 
-<img src="images/johndoe.png" width="200px">
+#### Developer and Test Lead
+* Ensures the testing of the project is done properly and on time.
+* Ensures that code coverage is not compromised even when new features are being added.
+* Holds everyone to a high standard of test code.
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Joshua Tan
 
-* Role: Team Lead
-* Responsibilities: UI
+<img src="images/joshtyf.png" width="200px">
 
-### Johnny Doe
+[[github](http://github.com/joshtyf)]
+[[portfolio](team/joshtyf.md)]
 
-<img src="images/johndoe.png" width="200px">
+#### Developer and Documentation Lead
+* Responsible for the quality of various project documents (eg. README.md, UG, DG).
+* Set goals for documenting new features and for improving the quality of existing documentation.
+* Review documents for accuracy and style and ensure all publication standards are met.
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+### Gilbert Tan
 
-* Role: Developer
-* Responsibilities: Data
+<img src="images/gilberttan19.png" width="200px">
 
-### Jean Doe
+[[github](https://github.com/GilbertTan19)]
+[[portfolio](team/gilberttan19.md)]
 
-<img src="images/johndoe.png" width="200px">
+#### Developer and Code Quality Lead
+* Looks after code quality of the entire codebase.
+* Ensures adherence to coding standards, javadocs, etc.
+* Set up code review process and ensures adherence to good code review practices.
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Xingjian Chen
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+<img src="images/chenxj98.png" width="200px">
 
-### James Doe
+[[github](https://github.com/ChenXJ98)]
+[[portfolio](team/chenxj98.md)]
 
-<img src="images/johndoe.png" width="200px">
+#### Developer and Integration Lead
+* In charge of versioning of the code, maintaining the code repository, integrating various parts of the software to create a whole.
+* Facilitates the merging of code into the production branch.
+* Ensures that integration tests are performed properly and on time.
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
-* Role: Developer
-* Responsibilities: UI