[CS2103T-T11-3] EventBook

.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

@@ -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/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions) [![codecov](https://codecov.io/gh/AY2324S2-CS2103T-T11-3/tp/graph/badge.svg?token=BLAYKG2PXC)](https://codecov.io/gh/AY2324S2-CS2103T-T11-3/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#https://se-education.org/#contributing) for more info.
+# EventBook
+As a student leader overseeing various events, it can be challenging to stay organized with numerous contacts across different events. EventBook is designed to simplify the management of contacts across various events. With EventBook, you can effortlessly organize and access contact details of individuals in different events, streamlining the process of communication and coordination.
+
+## Documentation
+For the detailed documentation of this project, see the **[EventBook Product Website](https://ay2324s2-cs2103t-t11-3.github.io/tp/index.html)**.
+
+### Acknowledgement
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -65,8 +65,12 @@ dependencies {
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
+run {
+    enableAssertions = true
+}
+
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'EventBook.jar'
 }
 
 defaultTasks 'clean', 'test'

data/addressbook.json

@@ -0,0 +1,183 @@
+{
+  "persons" : [ {
+    "name" : "Alex Yeoh",
+    "phone" : "99999999",
+    "email" : "[email protected]",
+    "address" : "Blk 30 Geylang Street 29, #06-40",
+    "tags" : [ "operations" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  }, {
+    "name" : "Bernice Yu",
+    "phone" : "99272758",
+    "email" : "[email protected]",
+    "address" : "Blk 30 Lorong 3 Serangoon Gardens, #07-18",
+    "tags" : [ "marketing" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  }, {
+    "name" : "Charlotte Oliveiro",
+    "phone" : "93210283",
+    "email" : "[email protected]",
+    "address" : "Blk 11 Ang Mo Kio Street 74, #11-04",
+    "tags" : [ "logistics" ],
+    "eventTags" : [ {
+      "tagName" : "Rag",
+      "description" : "Rag event",
+      "startDate" : "2024-04-05T14:00:00",
+      "endDate" : "2024-04-05T16:00:00"
+    } ]
+  }, {
+    "name" : "David Li",
+    "phone" : "91031282",
+    "email" : "[email protected]",
+    "address" : "Blk 436 Serangoon Gardens Street 26, #16-43",
+    "tags" : [ "publicity" ],
+    "eventTags" : [ {
+      "tagName" : "Rag",
+      "description" : "Rag event",
+      "startDate" : "2024-04-05T14:00:00",
+      "endDate" : "2024-04-05T16:00:00"
+    } ]
+  }, {
+    "name" : "Irfan Ibrahim",
+    "phone" : "92492021",
+    "email" : "[email protected]",
+    "address" : "Blk 47 Tampines Street 20, #17-35",
+    "tags" : [ "publicity" ],
+    "eventTags" : [ {
+      "tagName" : "Rag",
+      "description" : "Rag event",
+      "startDate" : "2024-04-05T14:00:00",
+      "endDate" : "2024-04-05T16:00:00"
+    } ]
+  }, {
+    "name" : "Roy Balakrishnan",
+    "phone" : "92624417",
+    "email" : "[email protected]",
+    "address" : "Blk 45 Aljunied Street 85, #11-31",
+    "tags" : [ "VPD" ],
+    "eventTags" : [ {
+      "tagName" : "Rag",
+      "description" : "Rag event",
+      "startDate" : "2024-04-05T14:00:00",
+      "endDate" : "2024-04-05T16:00:00"
+    } ]
+  }, {
+    "name" : "Tom Goh",
+    "phone" : "91234812",
+    "email" : "[email protected]",
+    "address" : "Blk 98 Telok Blangah Street 85, #11-09",
+    "tags" : [ "secretary" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  }, {
+    "name" : "John Tan",
+    "phone" : "91232345",
+    "email" : "[email protected]",
+    "address" : "Blk 1 Hougang Street 3, #07-18",
+    "tags" : [ "operations" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  }, {
+    "name" : "Ben Tan",
+    "phone" : "83478596",
+    "email" : "[email protected]",
+    "address" : "NA",
+    "tags" : [ "operations" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  }, {
+    "name" : "Ann Lee",
+    "phone" : "82882919",
+    "email" : "[email protected]",
+    "address" : "NA",
+    "tags" : [ "head", "publicity" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  }, {
+    "name" : "Amy Lim",
+    "phone" : "82882919",
+    "email" : "[email protected]",
+    "address" : "AMK Blk 91",
+    "tags" : [ "head", "operations" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  }, {
+    "name" : "Betty Ho",
+    "phone" : "93882919",
+    "email" : "[email protected]",
+    "address" : "AMK Blk 10",
+    "tags" : [ "logistics" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  }, {
+    "name" : "Zack Goh",
+    "phone" : "82820119",
+    "email" : "[email protected]",
+    "address" : "AMK Blk 10",
+    "tags" : [ "logistics" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  }, {
+    "name" : "Xan",
+    "phone" : "82882919",
+    "email" : "[email protected]",
+    "address" : "Bishan Blk 10",
+    "tags" : [ "logistics" ],
+    "eventTags" : [ {
+      "tagName" : "Flag",
+      "description" : "Flag event",
+      "startDate" : "2024-04-10T18:00:00",
+      "endDate" : "2024-04-10T22:00:00"
+    } ]
+  } ],
+  "tagList" : [ "head", "marketing", "secretary", "operations", "logistics", "neighbours", "VPD", "publicity" ],
+  "eventTagList" : [ {
+    "tagName" : "Flag",
+    "description" : "Flag event",
+    "startDate" : "2024-04-10T18:00:00",
+    "endDate" : "2024-04-10T22:00:00"
+  }, {
+    "tagName" : "Rag",
+    "description" : "Rag event",
+    "startDate" : "2024-04-05T14:00:00",
+    "endDate" : "2024-04-05T16:00:00"
+  } ]
+}

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,45 @@
 ---
-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
-
-<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
+### Owen
 
-### Jane Doe
+<img src="images/owenong1.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](https://github.com/owenong1)]
+* Role: Developer
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Yifei
 
-* Role: Team Lead
-* Responsibilities: UI
+<img src="images/peterxgd.png" width="200px">
 
-### Johnny Doe
+[[github](http://github.com/peterXGD)]
+* Role: Developer
 
-<img src="images/johndoe.png" width="200px">
+### Cleo
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+<img src="images/cleowenxuan.png" width="200px">
 
+[[github](http://github.com/cleowenxuan)]
 * Role: Developer
-* Responsibilities: Data
 
-### Jean Doe
+### Jonathan
 
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/jonpwk.png" width="200px">
 
+[[github](http://github.com/jonpwk)]
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
-
-### James Doe
 
-<img src="images/johndoe.png" width="200px">
+### Pei En
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/peienlim.png" width="200px">
 
+[[github](http://github.com/peienlim)]
 * 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