[CS2103T-T15-2] JCRoster+

.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

@@ -18,6 +18,10 @@ hs_err_pid[0-9]*.log
 # Test sandbox files
 src/test/data/sandbox/
 
+# Compiled files in bin
+bin/
+
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/

README.md

@@ -1,14 +1,67 @@
-[![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/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S2-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.
-  * 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/#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).
+# JCRoster+
+#### JCRoster+ streamlines contact management for Junior College homeroom teachers.
+
+* by providing quick access to student, and guardian details.
+* By integrating a smart tagging system it allows for quick categorization and seamless student grouping based on academic strengths.
+* Ultimately, it reduces administrative hassle and improves efficiency in managing classroom interactions.
+
+## Features:
+### Add Students ✏️
+#### Adds a student with their Grades to the address book.
+`add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS g/SUBJECT1:GRADE,SUBJECT2:GARDE,SUBJECT3:GARDE,SUBJECT4:GARDE,SUBJECT5:GARDE,SUBJECT6:GARDE [t/TAG]...`
+
+Example commands:<br>
+>add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 g/Math:A,Science:B,English:A,History:C,Geography:B,Music:A<br><br>
+add n/Betsy Crowe e/betsycrowe@example.com a/Newgate Prison p/1234567 g/Math:A,Science:C,English:A,History:C,Geography:B,Music:A t/friend
+
+
+### Delete Student 🗑️
+#### Removes a student’s record from the address book.
+`delete UID` <br>
+Example commands:<br>
+>delete 1234<br>
+delete 98765
+
+#### Removes multiple student's record from the address book.
+`delete INDEX1 INDEX2 ...` <br>
+Example commands:<br>
+>delete 1 3 5<br>
+
+### Find Person 🔍
+#### Searches for a person in the address book based on their name.
+
+`find KEYWORD [MORE_KEYWORDS]`
+
+Example commands:<br>
+>find John<br>
+find Betsy Crowe
+
+### Filter Person 🔽
+`filter KEYWORD [MORE_KEYWORDS]`
+
+Example commands:<br>
+>filter BadAtMath<br>
+
+
+### Add Remark 📝
+`remark INDEX r/[REMARK INPUT]`
+
+Example commands:<br>
+>remark 1 r/Poor <br>
+
+
+
+### Exit Program 🚪
+#### Terminates the application
+
+`exit`<br>
+Example command:
+>exit
+
+**More features coming up...**
+* For the detailed documentation of this project, see the **[JCRosters](https://ay2425s2-cs2103t-t15-2.github.io/tp/)**.

build.gradle

@@ -69,4 +69,8 @@ shadowJar {
     archiveFileName = 'addressbook.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,50 @@
 ---
-layout: page
-title: About Us
+  layout: default.md
+  title: "About Us"
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
+# About Us
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+We are team JCRoster+ based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
+
+Please contact heytheresakinah@gmail.com for any concerns and queries.
 
 ## Project team
 
-### John Doe
+### Farhan Navas
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/farhan-navas.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[//]: # ([[homepage]&#40;http://www.comp.nus.edu.sg/~damithch&#41;])
+[[github](https://github.com/farhan-navas)]
+[[portfolio](https://github.com/farhan-navas)]
 
 * Role: Project Advisor
 
-### Jane Doe
+### Nur Ain Sakinah
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/heyitssakinah.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[heyitssakinah](http://github.com/heyitssakinah)]
 
 * Role: Team Lead
 * Responsibilities: UI
 
-### Johnny Doe
+### Haridos Sreelakshmi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sreelakshmiharidos.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/sreelakshmiharidos)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Shared responsibilities in brownfield development, testing, admin tasks and documentation.
 
-### Jean Doe
+### Yin Can
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ypuppy.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ypuppy)]
+[[portfolio](team/ypuppy.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
-
-### James Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Developer
-* Responsibilities: UI
+* Responsibilities: Backend + waiting for my team member to save me

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