[CS2103T-T12-2] LookMeUp

.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'

.github/workflows/gradle.yml

@@ -39,7 +39,7 @@ jobs:
         run: ./gradlew check coverage
 
       - name: Upload coverage reports to Codecov
-        if: runner.os == 'Linux'
-        uses: codecov/codecov-action@v3
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: AidenLYT/tp

.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,30 @@
-[![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/AY2324S2-CS2103T-T12-2/tp/actions)
+
+# *LookMeUp*
 
 ![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.
+### Having TOO MANY contacts to keep track of?
+> e.g. friends from different parts of your school life?
+
+> e.g. friends from different committees and interest groups?
+
+### Fret not,
+this is **a project aimed to *streamline* YOUR campus life**.<br>
+
+## Why would LookMeUp be useful?
+As an address book for students living on NUS campus to manage contacts, LookMeUp is designed to enable TAGGING!
+* **Tagging** allows you to add **multiple tags** to each contact, to keep track of the different groups they belong to.
+* You may **filter** your contacts via the **tags**,
+so you can *easily find* the contacts you need from a particular group
+(e.g. when broadcasting announcements, scheduling meetings etc.)
+
+### How is LookMeUp created?
+* LookMeUp is **written in OOP fashion** - meaning, it is **easy to maintain AND _extend NEW features_!**.
+* It comes with a **reasonable level of user and developer documentation**.
+* Our documentation would be uploaded soon, do keep an eye out for it!
+
+### Acknowledgements
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+It  is a **part of the se-education.org** initiative. If you would like to contribute code to similar projects,
+see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.

build.gradle

@@ -63,10 +63,15 @@ dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-params', version: '5.10.0'
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = '[CS2103T-T12-2][LookMeUp].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,77 @@
 ---
-layout: page
-title: About Us
+  layout: default.md
+  title: "About Us"
 ---
 
+# About Us
+
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
+We are a group of Computer Science students undertaking CS2103T.
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+LookMeUp is an address book application that allows students to seamlessly save contacts of their peers in school. The team hopes that
+this product will serve student better convenience in connecting with their friends!
+For more enquiries, you can reach us at the email:
+1. Koo Zhuo Hui `[email protected]`
+2. Kervyn Tan `[email protected]`
+3. Lynnette Ong Xin Hui `[email protected]`
+4. Aiden Lee Yuan Ting `[email protected]`
+5. Chen Runjia `[email protected]`
 
-## Project team
+## Project Team
 
-### John Doe
+### Zhuo Hui Koo (Ivan)
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/smolegz.png" width="200px" style="border-radius:5%">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/smolegz)]
 
-* Role: Project Advisor
+Y2 CS student. My hobby is to drink w/ my besties; I am always the “take care of other ppl” 😊
 
-### Jane Doe
+* Role: Team Lead
+* Responsibilities: Testing
 
-<img src="images/johndoe.png" width="200px">
+### Kervyn Tan
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/kervyntan.png" width="200px" height="240px" style="border-radius:5%">
 
-* Role: Team Lead
-* Responsibilities: UI
+[[Github](http://github.com/kervyntan)]
 
-### Johnny Doe
+Y2, CS Major.
+Love cycling on the weekends and playing LoL when I have time (basically never)
+
+* Role: Developer
+* Responsibilities: Integration
 
-<img src="images/johndoe.png" width="200px">
+### Lynnette Ong
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+<img src="images/lynnetteeee.png" width="200px" style="border-radius:5%">
+
+[[Github](http://github.com/lynnetteeee)]
+
+Y2, CS, I love to travel (esp cold weather) and play squash!
+I think coding without a deadline is >>>>>>>> ! Lowkey therapeutic... but once theres deadline... >.<
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Code Quality
 
-### Jean Doe
+### Aiden Lee
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/aidenlyt.png" width="200px" height="240px" style="border-radius:5%">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/aidenlyt)]
+
+Year 2 CS student. I eat ice cream with chopsticks.
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Scheduling & Tracking
+
+### RunJia Chen
 
-### James Doe
+<img src="images/runjiachen.png" width="200px" height="240px" style="border-radius:5%">
 
-<img src="images/johndoe.png" width="200px">
+[[Github](http://github.com/RunjiaChen)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+Y1 CS, like to watch Marvel shows like Loki, What if
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Documentation

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