[CS2103T-F14b-3]

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: MarkBind Action
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+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: '^6.0.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,18 @@
-[![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/AY2526S1-CS2103T-F14b-3/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2526S1-CS2103T-F14b-3/tp/actions/workflows/gradle.yml)
 
+=======
+# TutorTrack
 ![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.
+**TutorTrack** is a desktop application designed to help secondary school tutors
+manage and track their students, classes, and assignments efficiently.
+It provides an intuitive CLI-focused interface for tutors to stay organized,
+monitor student progress, and save time on administrative tasks.
+
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+
+## Features
+- **Add Students**: Easily add new students to your database with their contact details and education level.
+- **Manage Classes**: Create and manage classes, assign students to classes.
+- **Track Assignments**: Keep track of assignments given to students and their submission status.
+- **Search Functionality**: Quickly find students or classes using search commands.

build.gradle

@@ -16,6 +16,10 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+run {
+    enableAssertions = true
+}
+
 checkstyle {
     toolVersion = '11.0.0'
 }
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'tutortrack.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/.nojekyll

@@ -0,0 +1 @@
+

docs/AboutUs.md

@@ -1,59 +1,60 @@
----
-layout: page
-title: About Us
----
+<frontmatter>
+  title: "About Us"
+</frontmatter>
 
-We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
+# 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
+### Yu Tingan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/llamawithhats.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[homepage](https://llamawithhats.github.io/ip/)]
+[[github](https://github.com/llamawithhats)]
+[[portfolio](team/llamawithhats.md)]
 
-* Role: Project Advisor
+* Role: Developer
 
-### Jane Doe
+### Beh Shao Ren
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ren0716.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ren0716)]
+[[portfolio](team/ren0716.md)]
 
-* Role: Team Lead
+* Role: Developer
 * Responsibilities: UI
 
-### Johnny Doe
+### Hnin Sat Phyu Sin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hninsatphyusin.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/hninsatphyusin)] [[portfolio](team/hninsatphyusin.md)]
 
 * Role: Developer
 * Responsibilities: Data
 
-### Jean Doe
+### Timothy Tia Yi Zhi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/timxthytia.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/timxthytia)]
+[[portfolio](team/timxthytia.md)]
 
 * Role: Developer
 * Responsibilities: Dev Ops + Threading
 
-### James Doe
+### Darren Sng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sngdarren.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/sngdarren)]
+[[portfolio](team/sngdarren.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Object Oriented Programming

docs/Configuration.md

@@ -1,6 +1,5 @@
----
-layout: page
-title: Configuration guide
----
+<frontmatter>
+  title: "Configuration Guide"
+</frontmatter>
 
 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,6 @@
----
-layout: page
-title: DevOps guide
----
-
-* Table of Contents
-{:toc}
-
---------------------------------------------------------------------------------------------------------------------
+<frontmatter>
+  title: "DevOps Guide"
+</frontmatter>
 
 ## Build automation