[CS2103T-W11-2] CCA Manager

.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

@@ -40,6 +40,7 @@ jobs:
 
       - 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: AY2324S2-CS2103T-W11-2/tp

.gitignore

@@ -21,3 +21,10 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/
+
+# VSCode files
+.vscode
+
+# Build folder
+bin

README.md

@@ -1,14 +1,16 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# CCA Manager
+
+[![CI Status](https://github.com/AY2324S2-CS2103T-W11-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-W11-2/tp/actions)
 
 ![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.
+* This is the **CCA Manager** project. We aim to help NUS CCA members improve their contact management.
+* Example usages:
+  * assign roles to contacts corresponding to their actual role in the CCA.
+  * form groups and sub-groups of contacts.
+* This project is ongoing and still a WIP.
+  * We aim to use multiple paradigms of programming, such as **OOP** and **functional** programming.
+    However, the main paradigm will be **OOP**.
+  * User and developer documentation is still a WIP, and will be updated soon.
+* For detailed information, please see the [CCA Manager Product Website](https://ay2324s2-cs2103t-w11-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

@@ -66,7 +66,13 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'ccamanager.jar'
+}
+
+// Credits to https://se-education.org/guides/tutorials/gradle.html#enabling-assertions
+// for how to do this.
+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,65 @@
 ---
-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`
 
 ## Project team
 
-### John Doe
+### Ken Jin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/fidget-spinner.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Fidget-Spinner/)]
+[[portfolio](team/fidget-spinner.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Logic
 
-### Jane Doe
+### Lifu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lifhoshi.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/LifHoshi)]
+[[portfolio](team/lifhoshi.md)]
 
-* Role: Team Lead
+* Role: Developer
 * Responsibilities: UI
 
-### Johnny Doe
+### Jules
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/juliapoo.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[homepage](https://juliapoo.github.io/)]
+[[github](http://github.com/JuliaPoo)]
+[[portfolio](team/juliapoo.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UI
 
-### Jean Doe
+### Jia Jie
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/chuahjiajie.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/chuahjiajie)]
+[[portfolio](team/chuahjiajie.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities:
+  * Logic
+  * Deliverables and Deadlines
 
-### James Doe
+### Jae Geun
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/alphajae11.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/alphajae11)]
+[[portfolio](team/alphajae11.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Logic

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