nus-cs2113-AY2021S1 · farice9 · Nov 9, 2020 · Nov 9, 2020 · Nov 9, 2020 · Nov 9, 2020
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -31,20 +31,4 @@ jobs:
           java-package: jdk+fx
 
       - name: Build and check with Gradle
-        run: ./gradlew check
-
-      - name: Perform IO redirection test (*NIX)
-        if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (MacOS)
-        if: always() && runner.os == 'macOS'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (Windows)
-        if: always() && runner.os == 'Windows'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        shell: cmd
-        run: runtest.bat
+        run: ./gradlew check
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,15 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+
+# Data files
+data/flashcard.txt
+data/timetable.txt
+data/bookmark.txt
+data/academic.txt
+StudyIt_Log.log
+StudyIt_Log.log.lck
+StudyIt_Logger.log
+StudyIt_Logger.log.1
+StudyIt_Logger.log.1.lck
+StudyIt_Logger.log.lck
diff --git a/Architecture.drawio b/Architecture.drawio
@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2020-10-27T15:37:53.968Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.80 Safari/537.36" version="13.8.5" etag="Q__1dEfyX0H9rvN0JhJ6" type="github"><diagram id="qLeCXLTED2RQiu_f9R3-">UzV2zq1wL0osyPDNT0nNUTV2VTV2LsrPL4GwciucU3NyVI0MMlNUjV1UjYwMgFjVyA2HrCFY1qAgsSg1rwSLBiADYTaQg2Y1AA==</diagram></mxfile>
diff --git a/Bookmark_ClassDiagram.drawio b/Bookmark_ClassDiagram.drawio
diff --git a/StudyIt_Log.log.lck b/StudyIt_Log.log.lck
diff --git a/build.gradle b/build.gradle
@@ -10,6 +10,7 @@ repositories {
 }
 
 dependencies {
+    implementation 'org.jetbrains:annotations:19.0.0'
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
 }
@@ -29,7 +30,15 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "StudyIt"
+}
+
+jar {
+    manifest {
+        attributes (
+            'Main-Class': 'StudyIt'
+        )
+    }
 }
 
 shadowJar {
@@ -41,6 +50,7 @@ checkstyle {
     toolVersion = '8.23'
 }
 
-run{
+run {
     standardInput = System.in
+    enableAssertions = true
 }
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -2,8 +2,10 @@
 
 Display | Name | Github Profile | Portfolio 
 --------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+
+![](https://via.placeholder.com/100.png?text=Photo) | Yuan Bing | [Github](https://github.com/farice9) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Si Hui | [Github](https://github.com/lingsihui) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Lu Ziyi | [Github](https://github.com/luziyi9898) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Florence Lim | [Github](https://github.com/hailqueenflo) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Lin Yuheng | [Github](https://github.com/slightlyharp) | [Portfolio](docs/team/johndoe.md)
+>>>>>>> master
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -1,33 +1,212 @@
 # Developer Guide
+##Content 
+[to be filled] 
+
+## Setting up, Getting Started
+###Setting up the project in your computer
+
+First, **fork** this repo, and **clone** the fork into your computer.
+
+If you plan to use Intellij IDEA (highly recommended):
+1. Configure the JDK: Configuring the JDK to ensure Intellij is configured to use JDK 11.
+2. Import the project as a Gradle project.
+3. Run the studyit.StudyIt and try a few commands.
+4. Run the tests to ensure they all pass.
+
+###Before writing code
+
+1. Configure the coding style. 
+Ensure Coding style is standardised throughout. 
+2. Learn the design. 
+When you are ready to start coding, we recommend that you get some 
+sense of the overall design by reading about AddressBook’s architecture.
 
 ## Design & implementation
+###Architecture
+[to be filled]
+###Bookmark Component
+
+This bookmark section consists of how the bookmark feature is implemented. 
+The bookmark feature is implemented similarly to the main architecture, however, 
+in a smaller scale and a more bookmark-specific way. Figure 1 illustrates the general overview, 
+the associations and the multiplicity of the bookmark classes.
+
+![Bookmark Class Diagram](Images/BookmarkRun_Class.png)
+
+API: java.bookmarkRun
+
+The bookmark component consists of six major classes: `BookmarkRun`, `BookmarkStorage`, `BookmarkUi`, 
+`BookmarkCategory`, `BookmarkList` and `BookmarkParser`. 
+As shown in figure 1, `BookmarkRun` is 
+* The main class to be called when the bookmark mode is accessed.
+* The main class to access other bookmark classes.
+
+Given below, Figure 2, is the sequence diagram of how the classes interact with each 
+other when bookmark mode is accessed from the main function.
+
+![Bookmark Sequence Diagram](Images/sequence_bookmark.png)
+
+The bookmark component has two modes: the main bookmark mode and the category mode. 
+As shown in Figure 2, when `BookmarkRun` is called, 
+`BookmarkParser` will be called and return a `BookmarkCommand`. 
+Afterwards, `BookmarkRun` will then call `executeCommand` in `BookmarkCommand` which executes 
+the intended actions 
+Then, it will call `getCategorymode` to get the current mode the user is in. 
+
+**Bookmark Implementation**
+
+A more detailed explanation of `BookmarkCommand`, `BookmarkCategory` and `BookmarkList` will be 
+shown below. `BookmarkUi` and `BookmarkStorage` follow the same design implementations as the main 
+architecture. The below figure shows the command classes available and they are called based on the 
+`BookmarkParser` class as illustrated in Figure 2. 
+
+![BookmarkCommand ClassDiagram](Images/bookmarkCommand_Class.png)
+
+Figure 4 shows a more detailed sequence diagram of how the `BookmarkCategory`, `BookmarkCommand` 
+and `BookmarkList` interacts with each other for the scenario when the user input an `AddLinkCommand` 
+in Bookmark mode.
+
+![BookmarkCommand ClassDiagram](Images/AddCommand_sequenceDiagram.png)
+
+### **Academic Component**
+
+This section will describe in detail how some features inside the academic tracker section have been implemented.
+Figure x illustrates the general overview, the associations and the multiplicity of the academic classes.
+
+![Academic_Class_Diagram](Images/Academic_Class_Diagram.png)
+
+API: `java.academic`
+
+The above diagram looks at the overall structure of how the academic tracker is being implemented. 
+This component is split into 7 different classes, 
+their associations and multiplicity as explained in the above diagram x. 
+The functions of the academic tracker will be called through the `AcademicRun` class 
+when the program is in academic mode, which will subsequently call 
+the functions in `PersonBook` or `GradeBook`. 
+
+The academic component:
+* initialises two arraylists, `ArrayList<Grade>` and `ArrayList<People>` 
+to store the relevant `Grade` and `People` objects.
+* uses `AcademicCommandParser` to parse the user command.
+* identifies `AcademicCommandType` to decide 
+which of the commands under `PersonBook` or `GradeBook` is to be executed.
+* calls `AcademicStorage` to store the current set of data into the local storage file.
+
+**Academic Implementation**
+
+This section explains the details on how certain features 
+are implemented in the academic tracker.
+
+**GradeBook Features**
+The grade features are facilitated `Gradebook`, which further make use of `Grade`. 
+All grades are stored internally under `AcademicRun` as an array list `ArrayList<Grade>`.
+It implements the following operations:
+* `addGrade(String[], ArrayList<Grade>)`:Adds a `Grade` to the `ArrayList<Grade>`. 
+* `printCap(ArrayList<Grade>)`:Calculate the current CAP based on the `ArrayList<Grade>`. 
+* `printListOfGrades(ArrayList<Grade>)`:Print out all the `Grade` that are currently stored inside `ArrayList<Grade>`.
+* `deleteGrade(Integer, ArrayList<Grade>)`:Delete a `Grade` from a specified index inside `ArrayList<Grade>`.
+* `suGradeInGradeBook(Integer, ArrayList<Grade>)`:Su a `Grade` from a specified index inside `ArrayList<Grade>`.
+* `starGrade(Integer, ArrayList<Grade>)`:Star a `Grade` from a specified index inside `ArrayList<Grade>`.
+* `combineGradeDetails(Grade)`:Print out the details of a particular `Grade`.
+
+### **Flashcard Component**
+
+This section will describe in detail how the flashcard feature is implemented.
+
+![Flashcard Component Class Diagram](Images/Flashcard_Class.png)
+
+The above diagram looks at the overall structure of how the flashcard component is being implemented. 
+This component is split into 4 different classes, their associations and multiplicity as explained in 
+the above Figure 7. As shown in Figure 7, the main class `FlashcardRun` will be accessed when the 
+flashcard mode is called in `StudyIt` Class. `FlashcardRun` class is associated with `FlashcardStorage` 
+class that is used to store data in .txt file and `FlashcardDeck` class which contains any number of `Flashcards`.
+
+**Flashcard Implementation**
+
+![Sequence Diagram when user input “add card” command](Images/addCard_sequenceDiagram.png)
+
+With reference to Figure 8, when `FlashcardRun` is first initialised by `StudyIt`, it will construct 
+the `FlashcardDeck` class. As an add card command is given by the user, `FlashcardRun` will take in the 
+command and call `addCard()` method in `FlashcardDeck` which constructs a new Flashcard object and stores 
+it inside the `FlashcardDeck` object.The `addCard()` function will then show the user the question and 
+answer of the flashcard that have been created.
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+##Documentation, logging, testing, configuration, dev-ops
+###Testing guide
+Running tests:  
+The main way that was used to run the test for Study It is:   
+Using IntelliJ JUnit test runner.   
+A. To run all tests, right-click on the src/test/java folder and choose 
+Run Test in ‘tp.test’  
+B. To run a subset of tests, you can right-click on a test package, 
+test class or a test and choose Run ‘ABC’.  
+Type of Tests  
+This project has 5 types of tests. 4 tests to test each feature and 1 test to test the main integration of the whole application.
 
+###Logging guide
+We are using java.util.logging package for logging 
+The StudyItLog class is used to manage the logging levels and logging destinations.
+Log messages are output through the console and to a  .log file.
+The output logging level can be controlled using .setlevel( )
+When choosing a level for a log message, follow the following conventions:
+1. SEVERE: A critical problem detected which may cause the termination of the application.
+2. WARNING: Can continue, but with caution.
+3. INFO: Information showing the noteworthy actions by the App.
+4. FINE:  Details that are not usually noteworthy but may be useful in debugging.
 
-## Product scope
-### Target user profile
 
-{Describe the target user profile}
+###DevOps Guide 
+Build automation  
+This project uses Gradle for build automation management.
+./gradlew build - check for checkstyle error and runs all tests
+Code coverage
+This project uses code coverage that is in IntelliJ IDE to check for the coverage of the code. 
 
-### Value proposition
+##Appendix: Requirement 
+### Product scope
+**Target user profile:**
+* studies in NUS
+* has a need to manage a significant number of links
+* has a need to manage their classes in a timetable
+* has a need to manage their grades
+* has a need to manage contact numbers of professors and teaching assistants.
+* has a need to memorise content to study 
+* prefer desktop apps over other types
+* can type fast
+* prefers typing to mouse interactions
+* is reasonably comfortable using CLI apps  
 
-{Describe the value proposition: what problem does it solve?}
+**Value proposition:**
+* manage links faster than a typical mouse/GUI driven app
+* manage grades more easily than a typical mouse/GUI driven app
+* manage contact numbers of professors and teaching assistants more effectively than a typical mouse/GUI driven app
+* manage timetable in a more organised manner than a typical mouse/GUI driven app
+* manage study content more efficiently than a typical mouse/GUI driven app 
 
-## User Stories
+#### User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
+|Version| As a ... | I want to ... | So that I ...|
 |--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+|v1.0|Student in Nus|organise my zoom links|don’t need to find the zoom link everytime lectures/tutorials start.|
+|v1.0|student attending online classes|keep track of the timetable of my lessons whether  it is online or offline|do not miss any lessons.|
+|v2.0|Student in Nus|organise all the useful signup links (internship/ hackathon/ talks) sent to our emails|can keep track of my time and dates of any relevant events.|
+|v1.0|Student in Nus|keep track of my results and the number of SUs I have left,|can plan my semester properly|
+|v1.0|student with packed timetables|see clashes in my timetable |can plan things without overlapping events.|
+|v1.0|student taking a mod that requires me to memorize a lot of contents|organize the contents into flashcards|can revise them on the go.|
+|v1.0|student who is worried about my results|calculate my CAP based on estimated grades|know i won’t get expelled :’)|
+|v1.0|Student in Nus|keep track of my profs and ta’s contacts|know who to find when i have troubles.|
+|v1.0|Student in Nus|bookmark all the important NUS websites|can access them more easily|
 
-## Non-Functional Requirements
+#### Non-Functional Requirements
 
-{Give non-functional requirements}
+* Should work on any [mainstream OS](#glossary) as long as it has Java 11 or above installed.
+* 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.
 
 ## Glossary
 
-* *glossary item* - Definition
+* *Mainstream OS* - Windows, Unix, Linux, OS-X
 
 ## Instructions for manual testing
 

diff --git a/docs/Images/Academic_Class_Diagram.png b/docs/Images/Academic_Class_Diagram.png
diff --git a/docs/Images/AddCommand_sequenceDiagram.png b/docs/Images/AddCommand_sequenceDiagram.png
diff --git a/docs/Images/BookmarkRun_Class.png b/docs/Images/BookmarkRun_Class.png
diff --git a/docs/Images/Flashcard_Class.png b/docs/Images/Flashcard_Class.png
diff --git a/docs/Images/addCard_sequenceDiagram.png b/docs/Images/addCard_sequenceDiagram.png
diff --git a/docs/Images/bookmarkCommand_Class.png b/docs/Images/bookmarkCommand_Class.png
diff --git a/docs/Images/sequence_bookmark.png b/docs/Images/sequence_bookmark.png
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<mxfile host="app.diagrams.net" modified="2020-10-27T15:37:53.968Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.80 Safari/537.36" version="13.8.5" etag="Q__1dEfyX0H9rvN0JhJ6" type="github"><diagram id="qLeCXLTED2RQiu_f9R3-">UzV2zq1wL0osyPDNT0nNUTV2VTV2LsrPL4GwciucU3NyVI0MMlNUjV1UjYwMgFjVyA2HrCFY1qAgsSg1rwSLBiADYTaQg2Y1AA==</diagram></mxfile>