[CS2103T-F12-1] NetConnect

.github/codecov.yml

@@ -0,0 +1,8 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 75%
+    patch:
+      default:
+        target: 75%

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+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'
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: AY2324S2-CS2103T-F12-1/tp

.github/workflows/gradle.yml

@@ -23,7 +23,7 @@ jobs:
 
       - name: Run repository-wide tests
         if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/.github
+        working-directory: ${{ github.workspace }}/.github
         run: ./run-checks.sh
 
       - name: Validate Gradle Wrapper
@@ -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/codecov-action@v4.0.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: AY2324S2-CS2103T-F12-1/tp

.gitignore

@@ -3,6 +3,9 @@
 /build/
 src/main/resources/docs/
 
+# Other build/bin files
+/bin/
+
 # IDEA files
 /.idea/
 /out/
@@ -21,3 +24,10 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/
+
+# VSCode configuration files
+.vscode/
+
+# NetConnect exported CSV files
+*.csv

README.md

@@ -1,14 +1,55 @@
-[![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/AY2324S2-CS2103T-F12-1/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2324S2-CS2103T-F12-1/tp/actions/workflows/gradle.yml/badge.svg)
+[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-F12-1/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2324S2-CS2103T-F12-1/tp)
+
+# NetConnect
+
+## Introduction
+
+NetConnect is a desktop app for food business managers managing contacts in SMEs, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). It enables managers to efficiently manage their employees, clients, as well as suppliers, **all in one place** ☝🏻.
 
 ![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)**.
+## Features
+
+1. Profile Management
+    * Add a new profile: Easily create a new profile for an employee, client, or supplier. You can choose to tag them with a custom tag.
+    * Delete or Edit a profile: Remove a profile from the list or Edit their information via their ID.
+
+
+2. Category Management
+    * Roles: Categorize your profiles into *Employees, Clients, or Suppliers*.
+    * Tailored profile information: Each of the roles have their own set of information to be filled in, e.g. Employees have the field `Department`, while Supplier have `Product`.
+
+3. Search. The searches can be stacked and allows you to find a profile based on the following criteria:
+    * Search by name: Find a profile by their name.
+    * Search by contact: Find a profile by their contact number.
+    * Search by tag: Find a profile by their tag.
+    * Search by role: Find a profile by their role.
+    * Search by remark: Find a profile by their remark.
+
+4. Related Profiles
+    * Relate profiles: Link profiles together to show their relationship.
+    * Unrelate profiles: Remove the relationship between two profiles.
+    * View related profiles: View all profiles related to a specific profile.
+
+5. Export
+    * Export profiles: Export all profiles to a CSV file.
+
+## User-Friendly Commands
+
+NetConnect uses simple CLI commands to make it easy for you to manage your contacts.
+
+## Warning System
+
+NetConnect will warn you if you are about to carry out a destructive action, and it requires your confirmation before execution. This ensures that you do not accidentally delete important information.
+
+## Error Handling
+
+With a robust error handling system, clear error and resolution messages will guide you through the process of managing your contacts seamlessly.
+
+## Getting Started
+To begin your journey with NetConnect, simply download the latest release from [here](https://github.com/AY2324S2-CS2103T-F12-1/tp/releases) and refer to the [User Guide](docs/UserGuide.md)
+for detailed guidance in using the application.
+
+For the detailed documentation of this project, see the **[NetConnect Website](https://ay2324s2-cs2103t-f12-1.github.io/tp/)**.
 * 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.

build.gradle

@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'netconnect.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

config/checkstyle/checkstyle.xml

@@ -310,7 +310,7 @@
 
     <module name="OperatorWrap">
       <!-- Checks that the non-assignment type operator is at the next line in a line wrap.
-           This includes "?", ":", "==", "!=", "/", "+", "-", "*", "%", ">>", ">>>",
+           This includes "?", ":", "==", "!=", "/", "+", " ", "*", "%", ">>", ">>>",
            ">=", ">", "<<", "<=", "<", "^", "|", "||", "&", "&&", "instanceof",
            "&" when used in a generic upper or lower bounds constraints,
              e.g. <T extends Foo & Bar>

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,62 @@
 ---
-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).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+You can reach us at the email `support@netconnect.tech`
 
 ## Project team
 
-### John Doe
+### Puri Virakarin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/purivirakarin.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/purivirakarin)]
+[[portfolio](team/purivirakarin.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Testing, Integration
 
-### Jane Doe
+### Rungrawin Chowiwattana
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nuyer.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/nuyer)]
+[[portfolio](team/nuyer.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Documentation, Testing
 
-### Johnny Doe
+### Sia Zhong Qing
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/starsia.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/starsia)]
+[[portfolio](team/starsia.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Team Lead
+* Responsibilities: Scheduling and tracking, Deliverables and Deadlines
 
-### Jean Doe
+### Shaun Lee Xuan Wei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/shaunlxw.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/shaunlxw)]
+[[portfolio](team/shaunlxw.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Scheduling and tracking, Testing
 
-### James Doe
+### Tan Jie Ling
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tanjieling0.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tanjieling0)]
+[[portfolio](team/tanjieling0.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: UI, Documentation, 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
 
@@ -73,7 +76,7 @@ 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. Update the version number in [`MainApp.java`](https://github.com/AY2324S2-CS2103T-F12-1/tp/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.