[CS2103-T14-1] EduConnect

.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

@@ -8,6 +8,9 @@ src/main/resources/docs/
 /out/
 /*.iml
 
+# VS Code files
+/.vscode/
+
 # Storage/log files
 /data/
 /config.json
@@ -21,3 +24,5 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/
+_markbind/logs/

README.md

@@ -1,14 +1,26 @@
-[![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-CS2103-T14-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103-T14-1/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#https://se-education.org/#contributing) for more info.
+# EduConnect
+
+* EduConnect is a contact management program for Teaching Assistants (TAs) in SoC, NUS to manage their classes and
+  students effectively.
+* It manages the student's particulars, timetables, and class progress, all in one program.
+* EduConnect is optimized for those who prefer to work with a Command Line Interface (CLI) while still having a simple
+  and clean Graphical User Interface (GUI).
+
+## Site Map
+
+---
+* [Main page](https://ay2324s2-cs2103-t14-1.github.io/tp/)
+  * [User Guide](https://ay2324s2-cs2103-t14-1.github.io/tp/UserGuide.html)
+  * [Developer Guide](https://ay2324s2-cs2103-t14-1.github.io/tp/DeveloperGuide.html)
+  * [About Us](https://ay2324s2-cs2103-t14-1.github.io/tp/AboutUs.html)
+
+
+## Acknowledgements
+
+---
+
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'educonnect.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -66,7 +70,10 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveBaseName.set("educonnect")
+    archiveClassifier.set(null)
+    archiveVersion.set("1.4")
+    dependsOn("distZip", "distTar")
 }
 
 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,78 @@
 ---
-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](http://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
+### Damith C. Rajapakse
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/damithc.png" width="200px">
 
 [[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/damithc)]
 
 * Role: Project Advisor
 
-### Jane Doe
+### Darryl Chan
+
+<img src="images/darryl-chan.png" width="200px">
+
+[[github](http://github.com/darryl-chan)]
+[[portfolio](team/darryl-chan.md)]
+
+* Role: Developer
+* Responsibilities: Testing
+
+### Shang Feiyang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/fy17ohhh.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/fy17ohhh)]
+[[portfolio](team/fy17ohhh.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Team Lead + UI
+
+### Tan Jia Jun
+
+<img src="images/tanjiajiajun.png" width="200px">
+
+[[github](https://github.com/tanjiajiajun)] [[portfolio](team/jiajun.md)]
+
+* Role: Developer
+* Responsibilities: Scheduling and tracking
 
-### Johnny Doe
+### Jeremiah Lim Zhi Zhong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jeremiahlzz.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/jeremiahlzz)]
+[[portfolio](team/jeremiah.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Integration
 
-### Jean Doe
+### Marcus Lam
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/marclamp.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/marclamp)]
+[[portfolio](team/marclamp)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Documentation + Code Quality
 
-### James Doe
+### Matthew Elmer Ken
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/matthewken19.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/matthewken19)]
+[[portfolio](team/matthewken19.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Deliverables and deadlines

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