[CS2103-T17-2] CampusBook

.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

@@ -2,11 +2,14 @@
 /.gradle/
 /build/
 src/main/resources/docs/
+*.class
+/bin/
 
 # IDEA files
 /.idea/
 /out/
 /*.iml
+/.vscode/
 
 # Storage/log files
 /data/
@@ -21,3 +24,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-T17-2/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2526S1-CS2103T-T17-2/tp/actions/workflows/gradle.yml)
 
-![Ui](docs/images/Ui.png)
+![Ui Mockup](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+* This is a project for **NUS Students** to track and access school-related contacts (e.g. Professors, Faculty Admins, Coursemates) with ease and efficiency.  
   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.
+  * as a centralized platform to record the contact details of professors for various modules
+  * as a quick reference for administrative staff information (e.g., faculty office, finance office, IT support)
+  * as a convenient address book to track a student's classmates
+* The project simulates a real-world software system for a desktop application (called _CampusBook_) used for managing and searching university contacts.
+  * It is **written in OOP fashion**. It provides a **well-structured** code base (~6 KLoC) that students can extend, without being overwhelmingly big.
+  * It comes with **comprehensive user and developer documentation**.
+* It is named `CampusBook` because it extends the AddressBook concept but adapted for a university context.
+* For the detailed documentation of this project, see the **[CampusBook Product Website](https://AY2526S1-CS2103T-T17-2.github.io/tp/)**.
+
+---
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -60,13 +60,19 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
+    implementation 'com.opencsv:opencsv:5.9'
+
     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 = 'CampusBook.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,48 @@
 ---
-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
-
-<img src="images/johndoe.png" width="200px">
-
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Project Advisor
+### Zuo Yi
 
-### Jane Doe
+<img src="images/nuszuoyi.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](https://github.com/nuszuoyi)]
+[[portfolio](team/zuoyi.md)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Team Lead
-* Responsibilities: UI
-
-### Johnny Doe
+* Role: Developer
 
-<img src="images/johndoe.png" width="200px">
+### Nicholas Lim
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+<img src="images/nicholaslimzixian.png" width="200px">
 
-* Role: Developer
-* Responsibilities: Data
+[[github](https://github.com/nicholaslimzixian)]
+[[portfolio](team/nicholaslimzixian.md)]
 
-### Jean Doe
+### David Joshua Sudartha
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/djsudartha.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/DJsudartha)]
+[[portfolio](team/djsudartha.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+=======
 
-### James Doe
+### Zhou Zirun
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sakichannn.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/sakichannn)]
+[[portfolio](team/sakichannn.md)]
 
 * Role: Developer
-* Responsibilities: UI
+=======

docs/CampusBook_contacts.csv

@@ -0,0 +1,7 @@
+"Name","Phone Number","Email","Address","Tags","Modules","Faculties","Favorites"
+"Alex Yeoh","87438807","alexyeoh@example.com","Blk 30 Geylang Street 29, #06-40","friends","CS2103T|MA1101R","Science","false"
+"Bernice Yu","99272758","berniceyu@example.com","Blk 30 Lorong 3 Serangoon Gardens, #07-18","ccamate|friends","CS2101","Business","false"
+"Charlotte Oliveiro","93210283","charlotte@example.com","Blk 11 Ang Mo Kio Street 74, #11-04","friends","GEQ1000","Arts","false"
+"David Li","91031282","lidavid@example.com","Blk 436 Serangoon Gardens Street 26, #16-43","labpartner","CS2105|CS2101","Computing","false"
+"Irfan Ibrahim","92492021","irfan@example.com","Blk 47 Tampines Street 20, #17-35","classmates","CS2103T","Engineering","false"
+"Roy Balakrishnan","92624417","royb@example.com","Blk 45 Aljunied Street 85, #11-31","classmates","GEQ1000|MA1101R","Business","false"

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