[CS2103T-W11-2] Treasura

.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

@@ -1,23 +1,39 @@
-# Gradle build files
-/.gradle/
-/build/
+# Gradle build artifacts
+.gradle/
+build/
 src/main/resources/docs/
 
-# IDEA files
-/.idea/
-/out/
-/*.iml
+# Do NOT ignore your build script.
+# You had "/.build.gradle" which would hide a hidden file ".build.gradle".
+# If that was a typo, delete that line.
 
-# Storage/log files
-/data/
-/config.json
-/preferences.json
-/*.log.*
+# IntelliJ IDEA
+.idea/
+out/
+*.iml
+
+# Storage / logs
+data/
+config.json
+preferences.json
+*.log
+*.log.*
 hs_err_pid[0-9]*.log
 
-# Test sandbox files
+# Test sandbox
 src/test/data/sandbox/
 
-# MacOS custom attributes files created by Finder
+# macOS and docs output
 .DS_Store
 docs/_site/
+docs/_markbind/logs/
+
+# SSH keys
+Yes
+Yes.pub
+
+# Keep Gradle wrapper files tracked
+!gradlew
+!gradlew.bat
+!gradle/wrapper/gradle-wrapper.jar
+!gradle/wrapper/gradle-wrapper.properties

README.md

@@ -1,14 +1,88 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# Team W11-2 — Treasura (Early Prototype)
+
+[![Build Status](https://github.com/AY2526S1-CS2103T-W11-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2526S1-CS2103T-W11-2/tp/actions)
+
+---
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+*Figure: Single mockup/screenshot of **Treasura**.*
+
+---
+
+## Overview
+
+**Treasura** is a desktop, **CLI-first** app that streamlines the workflow of **CCA treasurers**: add and manage members, record and review payments, and track simple expenses quickly and reliably.
+
+### Goals (early stage)
+
+- **Fast keyboard-centric flow** for data entry and lookup.
+- **Clean membership registry**: add/search/view members, archive inactive members.
+- **Lightweight bookkeeping**: record payments, see outstanding amounts, add/delete expenses; payments are shown **chronologically** in the UI.
+- **Automatic syncing** after successful changes (no manual backups).
+
+> We are still iterating—commands and UI may evolve.
+
+* 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.
+  * assist CCA treasurers to keep track of finances
+  * access member details 
+* The project simulates an ongoing software project for a desktop application (called _Treasura_) used for managing CCA finance 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` ...).
+* It is named `Treasura` because it was initially created to assist CCA treasures in keeping track of finances and member expenses.
 * 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.
+---
+
+## Early Command Sketch (subject to change)
+
+```bash
+# Add member
+# Adds a new member. On success, Treasura prints a single-line confirmation with all stored fields,
+# including an auto-assigned ID.
+member add n/NAME p/PHONE [e/EMAIL] [m/MATRICULATION NUMBER] [t/TAG]
+# Example:
+member add n/Chia Sin Jie p/91234567 e/sj@nus.edu.sg m/A00000000X t/year1 
+
+# Find member (by ID or name)
+# Displays the full profile. Duplicate names prompt for disambiguation.
+find id/<memberId>
+find n/<memberName>
+# Examples:
+find id/M1234
+find n/John Tan
+
+# Archive member
+# Moves an active member into an archive store and hides them from the default list.
+member archive /<memberId>
+# Example:
+member archive /a1b2c3d4
+
+# Record payment
+# Records a payment for a member (by ID or name), storing amount/date/remarks.
+# Payments are shown chronologically in the UI; outstanding amounts appear in the profile.
+payment add m/<memberId|memberName> amt/AMOUNT [d/YYYY-MM-DD] [r/REMARKS]
+# Examples:
+payment add m/M1234 amt/20 d/2025-09-01 r/"Membership fee"
+payment add m/"John Tan" amt/50 r/"CCA T-shirt"
+
+# View payments (chronological UI)
+# No command required; the payments panel lists entries by time automatically.
+
+# Add expense
+# Adds a new expense. Expense IDs must be unique.
+expense add n/NAME x/ID amt/VALUE d/YYYY-MM-DD [t/TAG]... [note/NOTE]
+# Example:
+expense add n/Equipment x/123 amt/200.00 d/2025-09-09 t/Sports t/Essential note/"Bought 5 basketballs"
+
+# Delete expense
+# Removes an expense by ID. If delete confirmations are enabled, confirm/yes is required.
+expense delete x/ID [confirm/yes]
+# Example:
+expense delete x/303 confirm/yes
+
+# Auto-sync
+# After successful state-changing commands (add/edit/delete/archive), data is automatically saved to storage.

build.gradle

@@ -69,4 +69,8 @@ shadowJar {
     archiveFileName = 'addressbook.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,61 @@
 ---
-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
+### Danton Yap
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/dnt0n.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/dnt0n)] [[portfolio](team/dnt0n.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Data
 
-### Jane Doe
+### Chia Sin Jie 
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sj-c.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/sjc)] [[portfolio](team/sjc.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Data
 
-### Johnny Doe
+### Foo Shao Jun
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/enamourous.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/enamourous)]
+[[portfolio](team/enamourous.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Dev Ops + Threading
+
 
-### Jean Doe
+### Roshan Kuna
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/roshan1572.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Roshan1572)]
+[[portfolio](team/roshan1572.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: UI
 
-### James Doe
+### Jianrong Gu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jianronggu.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jianronggu)]
+[[portfolio](team/jianronggu.md)]
 
 * 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