[CS2103-W17-1] MATHUTORING

.github/workflows/gradle.yml

@@ -44,3 +44,8 @@ jobs:
           directory: ${{ github.workspace }}/build/reports/jacoco/coverage
           files: coverage.xml
           fail_ci_if_error: false
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -20,3 +20,10 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+# Bin files
+bin/
+
+# Local Gemfile
+docs/Gemfile
+docs/Gemfile.lock

README.md

@@ -1,14 +1,15 @@
-[![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/AY2223S2-CS2103-W17-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S2-CS2103-W17-1/tp/actions)
+[![codecov](https://codecov.io/gh/AY2223S2-CS2103-W17-1/tp/branch/master/graph/badge.svg?token=XXJ15FVPPS)](https://codecov.io/gh/AY2223S2-CS2103-W17-1/tp)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+* This is **a product for private Math tuition teachers**.<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.
+  * as an application to manage their student contact details and performance.
+* The project simulates an ongoing software project for a desktop application (called _MATHUTORING_) used for managing student contact details and performance.
+  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base based on the original project **AB3**.
   * 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.
+* It is named `MATHUTORING v1.4` because it was initially created as a part of a series of `MATHUTORING` projects (`v1.1`, `v1.2`, `v1.3` ...).
+* For the detailed documentation of this project, see the **[MATHUTORING Product Website](https://github.com/AY2223S2-CS2103-W17-1/tp)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+

build.gradle

@@ -40,6 +40,10 @@ task coverage(type: JacocoReport) {
     }
 }
 
+run {
+    enableAssertions = true
+}
+
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
@@ -60,13 +64,21 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
+    implementation 'org.apache.pdfbox:pdfbox:2.0.27'
+
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
+    testImplementation "org.mockito:mockito-core:3.+"
+    testImplementation "org.mockito:mockito-inline:4.2.0"
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'mathutoring.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

data.json

@@ -0,0 +1,29 @@
+{
+  "persons" : [ {
+    "name" : "Bernice Yu",
+    "phone" : "99272758",
+    "email" : "[email protected]",
+    "address" : "Blk 30 Lorong 3 Serangoon Gardens, #07-18",
+    "parentPhone" : "94597742",
+    "tagged" : [ "colleagues", "friends" ],
+    "taskList" : [ ],
+    "scores" : [ {
+      "label" : "midterm",
+      "value" : "99.8",
+      "date" : "2019-09-09"
+    }, {
+      "label" : "midterm",
+      "value" : "85.5",
+      "date" : "2020-02-01"
+    } ]
+  }, {
+    "name" : "Irfan Ibrahim",
+    "phone" : "92492021",
+    "email" : "[email protected]",
+    "address" : "Blk 47 Tampines Street 20, #17-35",
+    "parentPhone" : "88814569",
+    "tagged" : [ "classmates" ],
+    "taskList" : [ ],
+    "scores" : [ ]
+  } ]
+}

docs/AboutUs.md

@@ -9,51 +9,52 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Toh Xin Yi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/toh-xinyi.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/toh-xinyi)]
+[[portfolio](team/toh-xinyi.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: In charge of Storage
 
-### Jane Doe
+### Gwyneth Guo Bai Ling
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/gwynethguo.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/gwynethguo)]
+[[portfolio](team/gwynethguo.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: In charge of Model
 
-### Johnny Doe
+### Li Yuxuan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/carrieli1015.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/carrieli1015)]
+[[portfolio](team/carrieli1015.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: In charge of UI
 
-### Jean Doe
+### Qiu Qianhui
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/qqh0828.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/qqh0828)]
+[[portfolio](team/qqh0828.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: In charge of Logic
 
-### James Doe
+### Quek Jing Ling, Brian
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/astraxq.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/astraxq)]
+[[portfolio](team/astraxq.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: In charge of UI

docs/DevOps.md

@@ -3,8 +3,12 @@ layout: page
 title: DevOps guide
 ---
 
-* Table of Contents
-{:toc}
+## Table of Contents
+* **[Build automation](#build-automation)**
+* **[Continuous integration (CI)](#continuous-integration-ci)**
+* **[Code coverage](#code-coverage)**
+* **[Repository-wide checks](#repository-wide-checks)**
+* **[Making a release](#making-a-release)**
 
 --------------------------------------------------------------------------------------------------------------------