[CS2103-F10-4] TutorProMax

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: MarkBind Action
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'zulu'
+      - name: Build & Deploy MarkBind site
+        uses: MarkBind/markbind-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          rootDirectory: './docs'
+          baseUrl: '/tp' # assuming your repo name is tp
+          version: '^5.5.2'

.gitignore

@@ -21,3 +21,4 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/

README.md

@@ -1,14 +1,13 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![Java CI](https://github.com/AY2425S2-CS2103-F10-4/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2425S2-CS2103-F10-4/tp/actions/workflows/gradle.yml)
+[![codecov](https://codecov.io/github/AY2425S2-CS2103-F10-4/tp/graph/badge.svg?token=Pv78PvaY52)](https://codecov.io/github/AY2425S2-CS2103-F10-4/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.
   * 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)**.
+* It is named `TutorProMax` because it was created for tutors with weekly tuition arrangements. This address book can help tutors keep track of students' contact details.
+* For the detailed documentation of this project, see the **[TutorProMax Website](https://ay2425s2-cs2103-f10-4.github.io/tp/AboutUs.html)**.
 * 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/#contributing-to-se-edu) for more info.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org)
+

build.gradle

@@ -31,7 +31,11 @@ task coverage(type: JacocoReport) {
     executionData.from files(jacocoTestReport.executionData)
     afterEvaluate {
         classDirectories.from files(classDirectories.files.collect {
-            fileTree(dir: it, exclude: ['**/*.jar'])
+            fileTree(dir: it, exclude: [
+                    '**/*.jar',
+                    'seedu/address/ui/HelpWindow.class',
+                    'seedu/address/ui/WrappedTextTableCellFactory.class'
+            ])
         })
     }
     reports {
@@ -59,14 +63,19 @@ 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 'com.googlecode.libphonenumber:libphonenumber:8.13.10'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'tutorpromax.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+  - "src/main/java/seedu/address/ui"

docs/.gitignore

@@ -0,0 +1,23 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+_markbind/logs/
+
+# Dependency directories
+node_modules/
+
+# Production build files (change if you output the build to a different directory)
+_site/
+
+# Env
+.env
+.env.local
+
+# IDE configs
+.vscode/
+.idea/*
+*.iml

docs/AboutUs.md

@@ -1,59 +1,87 @@
----
-layout: page
-title: About Us
----
 
-We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
 
-## Project team
 
-### John Doe
 
-<img src="images/johndoe.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
-* Role: Project Advisor
 
-### Jane Doe
 
-<img src="images/johndoe.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
-* Role: Team Lead
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+---
+  layout: default.md
+  title: "About Us"
+---
+
+# 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
+
+### Brandon Koh
+
+<img src="images/brvndonkoh.png" width="200px">
+
+[[github](http://github.com/brvndonkoh)]
+[[portfolio](team/brvndonkoh.md)]
+
+* Role: Developers
 * Responsibilities: UI
 
-### Johnny Doe
+### Huang Tian
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/huangtian666.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/huangtian666)] [[portfolio](team/huangtian666.md)]
 
 * Role: Developer
 * Responsibilities: Data
 
-### Jean Doe
+### David Chong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/davidchongg.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/davidchongg)]
+[[portfolio](team/davidchongg.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Backend
 
-### James Doe
+### Jeron Kor
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jeronkk.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jeronkk)]
+[[portfolio](team/jeronkk.md)]
 
 * Role: Developer
 * Responsibilities: UI

docs/Configuration.md

@@ -1,6 +1,8 @@
 ---
-layout: page
-title: Configuration guide
+  layout: default.md
+  title: "Configuration guide"
 ---
 
+# Configuration guide
+
 Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).

docs/DevOps.md

@@ -1,12 +1,15 @@
 ---
-layout: page
-title: DevOps guide
+  layout: default.md
+  title: "DevOps guide"
+  pageNav: 3
 ---
 
-* Table of Contents
-{:toc}
+# DevOps guide
 
---------------------------------------------------------------------------------------------------------------------
+<!-- * Table of Contents -->
+<page-nav-print />
+
+<!-- -------------------------------------------------------------------------------------------------------------------- -->
 
 ## Build automation