[CS2103-F11-3] RealtorTrackerPlusMax

.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: '11'
+          distribution: 'temurin'
+      - name: Build & Deploy MarkBind site
+        uses: MarkBind/markbind-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          rootDirectory: './docs'
+          baseUrl: '/tp' # replace with your repo name
+          version: '^5.1.0'

.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,18 @@
-[![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/AY2324S1-CS2103T-F11-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-F11-3/tp/actions)
 
+Bonjour fellow realtors and open-source users.
 ![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.
+* It is named `RealtorTrackerPlusMax` (`RTPM` for short) because it is designed for realtors to track their contacts.
+* For the detailed documentation of this project, please see the [project website](https://ay2324s1-cs2103t-f11-3.github.io/tp/) which contains the user and developer guide.
+* This is a brownfield project, which was based off the initial AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+* Our project is open-source and in OOP design.
+> “This revolutionary app has changed the way I use the toilet” - James Dareal Ter, realtor, 24 years old
+
+> “This app gave me an A+ for 2040”
+
+> ”If only i could get a job in cs, but this is good too i guess” - Jayden, unemployed CS grad
+
+> “Fork RTPM”
+
+> ”RTPM cured my cancer”

build.gradle

@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'RTPM.jar'
 }
 
 defaultTasks 'clean', 'test'

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,61 @@
 ---
-layout: page
-title: About Us
+  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
 
-### John Doe
+### Jia Hao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/j-hta-n.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/j-hta-n)]
+[[portfolio](team/j-hta-n.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Code Quality
 
-### Jane Doe
+### Andy Toh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/andytoh1.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/andytoh1)]
+[[portfolio](team/andytoh1.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Documentation
 
-### Johnny Doe
+### Tsai Ian Fourre
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/iantsaii.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/iantsaii)] [[portfolio](team/iantsaii.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Quality assurance: Simulated System and Acceptance Testing
 
-### Jean Doe
+### Wong Xing Hui Bertrand
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/peasantbird.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/peasantbird)]
+[[portfolio](team/peasantbird.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Code Quality
 
-### James Doe
+### Ruiyang Zhao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ruiyangzh.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ruiyangzh)]
+[[portfolio](team/ruiyangzh.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Developer Testing

docs/Configuration.md

@@ -1,6 +1,9 @@
 ---
-layout: page
-title: Configuration guide
+  layout: default.md
+  title: "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`).
+# 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