[CS2103-F15-2] EduContacts

.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,47 @@
-[![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/AY2425S1-CS2103T-F15-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-F15-2/tp/actions)
+[![CI Status](https://github.com/AY2425S1-CS2103T-F15-2/tp/workflows/MarkBind%20Action/badge.svg)](https://github.com/AY2425S1-CS2103T-F15-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.
+# EduContacts
+
+**EduContacts** is a desktop application designed for **tertiary teachers and educators** to manage contacts with
+students, parents, and faculty across multiple classes or educational years.
+
+- It is optimized for those who prefer to work with a **Command Line Interface** (CLI) while still having the
+- benefits of a **Graphical User Interface** (GUI).
+- It helps educators keep communication organized, track academic progress, and support parent-teacher interactions
+- efficiently, often across large groups.
+
+## Value Proposition
+
+An address book tailored for educators simplifies student and parent contact management, enhances communication
+tracking, and integrates progress reports, helping teachers save time and foster effective collaboration across the school community.
+
+## Features
+
+- **Class/Group-Based Contact Management**: Organize contacts by class, subject, or school year for easy access.
+- **Parent-Teacher Communication Tracking**: Keep a history of messages or meetings with parents and faculty.
+- **Student Progress and Grade Tracking**: Link contact information with student records and academic performance.
+- **Event Scheduling and Reminders**: Integrate with school calendars to manage parent-teacher meetings,
+report deadlines, or school events.
+- **Group Messaging**: Enable teachers to send messages to an entire class or group of parents at once,
+streamlining communication.
+- **Custom Fields**: Add notes for individual students (e.g., learning accommodations,
+behavioral issues, or special needs).
+- **Integration with School Management Systems**: Sync with platforms like Google Classroom or
+school LMS (Learning Management Systems).
+
+## Getting Started
+
+For the detailed documentation of this project, see the **[EduContacts Product Website](https://ay2425s1-cs2103t-f15-2.github.io/tp/index.html)**
+
+Our product website is currently in development. Check back soon!
+
+## Contributing
+
+This project is developed as part of the **CS2103T Software Engineering** module at the **National University of Singapore**.
+
+---
+
+*This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).*

build.gradle

@@ -61,12 +61,15 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
     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 = 'educontacts.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

copyright.txt

@@ -1,7 +1,7 @@
 Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
 
 Copyright by Susumu Yoshida - http://www.mcdodesign.com/
-- address_book_32.png
+- edu_contacts_32.png
 - AddressApp.ico
 
 Copyright by Jan Jan Kovařík - http://glyphicons.com/

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,55 @@
 ---
-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 a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
 ## Project team
 
-### John Doe
+### Julian Tay
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/juliantayyc.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](https://github.com/juliantayyc)]
 
-* Role: Project Advisor
+* Role: Team Lead
 
-### Jane Doe
+### Ethan Goh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ethan-goh.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/ethan-goh)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Code Quality
+* Responsibilities: Ensure code follows the code quality requirements as outlined by the course.
 
-### Johnny Doe
+### Brandon Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/btbrandon.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[Github](http://github.com/btbrandon)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Deliverables and Deadlines
+* Responsibilities: Ensure team deliverables meet the deadlines as outlined by the course.
 
-### Jean Doe
+### Jessica
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jessica2828.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/jessica2828)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Scheduling and Tracking
+* Responsibilities: Assigning and managing tasks
 
-### James Doe
+### Jun Yu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jyl27.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/jyl27)]
 
 * 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