[CS2103T-T15-2] AronaPro

.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' # assuming your repo name is tp
+          version: '^5.2.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,48 @@
-[![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/AY2324S2-CS2103T-T15-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-T15-2/tp/actions)
 
 ![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.
+## Arona Pro
+* This is **a sample project given to Software Engineering (SE) students**.<br>
+* The project simulates an ongoing software project for a desktop application (called _AronaPro_) catered for
+  Computer Science teaching assistants who appreciate an organised and vibrant approach to query,
+  and manage an array of students and professors’ contacts with CLI.
+
+  * It is **written in OOP fashion**.
   * 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` ...).
+
+### Main features include:
+
+
+#### View Contact Information
+Description: `View` command allows you to see all the existing contacts of your students
+>Format: `view`
+
+#### Add New Contacts
+Description: `Add` command allows you to add new contacts of your students into the address book
+>Format: `id/NUSID n/NAME p/PHONE [e/EMAIL] [t/TAG]`
+
+#### Edit Existing Contacts
+Description: `Edit` command allows you to edit existing contacts of your students in the address book
+>Format: `edit id/NUSID [n/NEWNAME] [p/NEWPHONE] [e/NEWEMAIL]`
+
+#### Delete Existing Contacts
+Description: `Delete` command allows you to delete existing contacts in the address book
+>Format: `delete id/NUSID`
+
+#### Filtering Existing Contacts
+Description: `Filter` command allows you to filter desired contacts in the address book based on group
+and tag specified
+>Format: `filter [n/NAME] [p/PHONE] [e/EMAIL] [g/GROUP] [t/TAG]`
+
+#### Assign contacts a tutorial group
+Description: `Assign` command allows you to assign students into their respective tutorial groups in the
+address book
+>Format: `assign id/NUSID [g/GROUP] [t/TAG]`
+
+#### Add Schedule
+Description: `Schedyle` command allows you to schedule an appointment with students
+>Format: `schedule id/NUSID d/DATE from/FROM [to/TO] [t/TAG] [r/REMARK]`
+
 * 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.

build.gradle

@@ -66,7 +66,12 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'aronapro.jar'
 }
 
+run {
+    enableAssertions = true
+}
+
+
 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,65 @@
 ---
-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
 
-<img src="images/johndoe.png" width="200px">
+### Cheah Tze Juen
+
+<img src="images/cheahtj.png" width="200px">
+
+[[github](https://github.com/cheahTJ)]
+[[portfolio](team/cheahtj.md)]
+
+* Roles: Team Lead
+* Responsibilities:
+    * Dedicates tasks among team and facilitate coordination among team members
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
-* Role: Project Advisor
+### Tan Hong Jun
 
-### Jane Doe
+<img src="images/hjuntan.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](http://github.com/hjuntan)]
+[[portfolio](team/hjuntan.md)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+* Role: Documentation
+* Responsibilities: Ensures that all documentation are up-to-date and are specific to the user
 
-* Role: Team Lead
-* Responsibilities: UI
+### Loh Jin Hun
 
-### Johnny Doe
+<img src="images/ragnapop.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](http://github.com/Ragnapop)] [[portfolio](team/ragnapop.md)]
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+* Role: Testing
+* Responsibilities: Ensures that all features are properly tested, even on edge cases
 
-* Role: Developer
-* Responsibilities: Data
+### Chen Kuan Min
 
-### Jean Doe
+<img src="images/rikko1204.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](http://github.com/Rikko1204)]
+[[portfolio](team/rikko1204.md)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+* Role: Scheduling and tracking
+* Responsibilities: Ensures that the team is on pace with the 2 weeks sprint and helps assign
+  task equally to members
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+### Guo Yuhao
 
-### James Doe
+<img src="images/ringoftheking.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](http://github.com/RingoftheKing)]
+[[portfolio](team/ringoftheking.md)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+* Role: Deliverables and deadlines
+* Responsibilities: Ensures that the team is focussed on the individual task and is able to deliver the intended feature
 
-* 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