[CS2103-T13-4] EduBase

.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: '^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,13 @@
-[![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/AY2526S1-CS2103T-T13-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2526S1-CS2103T-T13-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2526S1-CS2103T-T13-4/tp/graph/badge.svg?token=z26EL45pZ3)](https://codecov.io/gh/AY2526S1-CS2103T-T13-4/tp)
 
 ![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 is CS2103T-T13-4's project, EduBase called EB for short.
+
+- It allows for tutors to track students and class data.
+- It is primarily CLI-based, allowing tutors to track student information at a fast pace.
+- If you would like to use EduBase, here is the [User Guide](docs/UserGuide.md).
+- If you are a developer and would like to contribute to EduBase, here is the [Developer Guide](docs/DeveloperGuide.md).
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

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 = 'edubase.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/AboutUs.md

@@ -1,59 +1,51 @@
 ---
-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).
+
+You can reach us at the email `e1398507@u.nus.edu` and include `[EduBase]` in the email header.
 
 ## Project team
 
-### John Doe
+### Goh Jin Yu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/beastarz.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Beastarz)]
+[[portfolio](team/beastarz.md)]
 
-* Role: Project Advisor
 
-### Jane Doe
+### Tan Yu Hang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/gnahuy123.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/gnahuy123)]
+[[portfolio](team/gnahuy123)]
 
-* Role: Team Lead
-* Responsibilities: UI
 
-### Johnny Doe
+### Desmond Wong Hui Sheng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/desmondwong1215.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/desmondwong1215)] [[portfolio](team/desmondwong1215.md)]
 
-* Role: Developer
-* Responsibilities: Data
 
-### Jean Doe
+### Reine Ong Eng Qin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/reineoeq.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/reineoeq)]
+[[portfolio](team/reine.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
 
-### James Doe
+### Yeo Wen Han, Marcus
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/siuuuuuuuuuuuuuuuuuu.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/siuuuuuuuuuuuuuuuuuu)]
+[[portfolio](team/marcus.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
 
@@ -74,6 +77,6 @@ Any warnings or errors will be printed out to the console.
 Here are the steps to create a new release.
 
 1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
-1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
-1. Tag the repo with the version number. e.g. `v0.1`
-1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.
+2. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
+3. Tag the repo with the version number. e.g. `v0.1`
+4. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.