[CS2103T-T15-2] Flash Notes

.gitignore

@@ -7,6 +7,7 @@ src/main/resources/docs/
 /.idea/
 /out/
 /*.iml
+*.iml
 
 # Storage/log files
 /data/

README.md

@@ -1,14 +1,10 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2021S1-CS2103T-T15-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-T15-2/tp/actions)
+[![codecov](https://codecov.io/gh/AY2021S1-CS2103T-T15-2/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103T-T15-2/tp)
 
 ![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.
+* This project simulates an ongoing software project for a desktop application (called _FlashNotes_) used for managing flashcards.
   * 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.
+* For the detailed documentation of this project, see the **[Flash Notes Product Website](https://ay2021s1-cs2103t-t15-2.github.io/tp/) **.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org) 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.

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.flashnotes.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'flashnotes.jar'
 }
 
 defaultTasks 'clean', 'test'
+
+run {
+    enableAssertions = true
+}

config/checkstyle/checkstyle.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE module PUBLIC
-    "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
-    "https://checkstyle.org/dtds/configuration_1_3.dtd">
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">
 
 <!--
     This configuration file enforces rules for a modified version of the module's code standard at
@@ -56,11 +56,11 @@
       4. THIRD_PARTY_PACKAGE: defined as com imports
     -->
     <module name="CustomImportOrder">
-        <property name="customImportOrderRules"
-            value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
-        <property name="specialImportsRegExp" value="^org\."/>
-        <property name="thirdPartyPackageRegExp" value="^com\."/>
-        <property name="sortImportsInGroupAlphabetically" value="true"/>
+      <property name="customImportOrderRules"
+                value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
+      <property name="specialImportsRegExp" value="^org\."/>
+      <property name="thirdPartyPackageRegExp" value="^com\."/>
+      <property name="sortImportsInGroupAlphabetically" value="true"/>
     </module>
 
     <!-- Checks for redundant import statements.
@@ -188,13 +188,10 @@
     <module name="NeedBraces">
       <!--
       if (true) return 1; // Not allowed
-
       if (true) { return 1; } // Not allowed
-
       else if {
         return 1; // else if should always be multi line
       }
-
       if (true)
         return 1; // Not allowed
       -->
@@ -216,7 +213,7 @@
       some other variants which we don't publicized to promote consistency).
       -->
       <property name="reliefPattern"
-       value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
+                value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
     </module>
 
     <module name="MissingSwitchDefault"/>
@@ -359,14 +356,12 @@
     -->
     <module name="SingleSpaceSeparator">
       <!-- Validate whitespace surrounding comments as well.
-
            a = 1; // Allowed (single space before start of comment)
            a = 1; /* Allowed (single space before start of comment) */
            /* Allowed (single space after end of comment) */ a = 1;
            a = 1;  // Not allowed (more than one space before start of comment)
            a = 1;  /* Not allowed (more than one space before start of comment) */
            /* Not allowed (more than one space after end of comment) */  a = 1;
-
            This doesn't validate whitespace within comments so a comment /* like  this */ is allowed.
       -->
       <property name="validateComments" value="true"/>

docs/AboutUs.md

@@ -5,55 +5,55 @@ title: About Us
 
 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
+### Jacob Chia Chu You
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/chuyouchia.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/chuyouchia)]
+[[portfolio](team/chuyouchia.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: UI
 
-### Jane Doe
+### Foong Siqi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/foongsq.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/foongsq)]
+[[portfolio](team/foongsq.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Deliverables and Deadlines
+* Responsibilities: Ensure project deliverables are done on time and in the right format.
 
-### Johnny Doe
+### Sruthi Saravanan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sruthisarav.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/Sruthisarav)]
+[[portfolio](team/sruthisarav.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Documentation
+* Responsibilities: Responsible for the quality of various project documents.
 
-### Jean Doe
+### Peng Xiang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/pengxiangg.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://https://github.com/pengxiangg)]
+[[portfolio](team/pengxiangg.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Integration
+* Responsibilities: In charge of versioning of the code, maintaining the code repository,
+integrating various parts of the software to create a whole.
 
-### James Doe
+### Rachel Ho Xin Ying
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/rachel170.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/rachel170)]
+[[portfolio](team/rachel170.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Testing
+* Responsibilities: Ensures the testing of the project is done properly and on time.

docs/DevOps.md

@@ -46,27 +46,6 @@ As part of CI, this project uses Codecov to generate coverage reports. Here are
 1. Once you are inside Codecov web app, add your fork to CodeCov.
 1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) in that page reflects the coverage of your project.
 
-### Repository-wide checks
-
-In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.
-
-These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:
-
-`./config/travis/run-checks.sh`
-
-Any warnings or errors will be printed out to the console.
-
-**If adding new checks:**
-
-* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.
-
-* Check scripts should print out errors in the format `SEVERITY:FILENAME:LINE: MESSAGE`
-  * SEVERITY is either ERROR or WARN.
-  * FILENAME is the path to the file relative to the current directory.
-  * LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.
-
-* Check scripts must exit with a non-zero exit code if any errors occur.
-
 --------------------------------------------------------------------------------------------------------------------
 
 ## Making a release