[CS2103T-T16-4] Teletutor

.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,12 @@
-[![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-T16-4/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2425S1-CS2103T-T16-4/tp/actions)
 
-![Ui](docs/images/Ui.png)
+![Ui](docs/images/DataUi.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.
+* This is **a  project by NUS Software Engineering (SE) students**.<br>
+  Usages:
+  * as an application for tutors to manage their classes, including student details, assignments, and attendance. 
+* The project is an ongoing software project for a desktop application (called _Teletutors_) used by tutors for managing their classes.
   * 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.
+* For the detailed documentation of this project, see the **[Teletutors Product Website](https://ay2425s1-cs2103t-t16-4.github.io/tp/index.html)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'Teletutor.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,64 @@
 ---
-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
+
+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
+### Nathan Loo
+
+<img src="images/natlv.png" width="200px">
+
+[[homepage](https://nathan-loo.vercel.app)]
+[[github](https://github.com/natlv)]
+[[portfolio](team/natlv.md)]
 
-<img src="images/johndoe.png" width="200px">
+* Role:
+* Responsibilities:
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Jerrell Lee
 
-* Role: Project Advisor
+<img src="images/jerrelllee.png" width="200px">
 
-### Jane Doe
+[[github](https://github.com/jerrelllee)]
+[[portfolio](team/jerrelllee.md)]
 
-<img src="images/johndoe.png" width="200px">
+* Role:
+* Responsibilities:
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Wee Kean
 
-* Role: Team Lead
-* Responsibilities: UI
+<img src="images/edsel-tan.png" width="200px">
 
-### Johnny Doe
+[[github](http://github.com/edsel-tan)] [[portfolio](team/edsel-tan.md)]
 
-<img src="images/johndoe.png" width="200px">
+* Role: Senior Finance Manager
+* Responsibilities:
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+### Ansel Chong
 
-* Role: Developer
-* Responsibilities: Data
+<img src="images/ansel-ch.png" width="200px">
 
-### Jean Doe
+[[github](https://github.com/Ansel-Ch)]
+[[portfolio](team/ansel-ch.md)]
 
-<img src="images/johndoe.png" width="200px">
+* Role:
+* Responsibilities:
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Hugh
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+<img src="images/gnoossk.png" width="200px">
 
-### James Doe
+[[github](http://github.com/gnoossk)]
+[[portfolio](team/gnoossk.md)]
 
-<img src="images/johndoe.png" width="200px">
+* Role: Software Developer
+* Responsibilities: Attendance and Storage Manager
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
-* 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