[CS2113-T12-2] BookKeeper

.github/workflows/gradle.yml

@@ -22,11 +22,12 @@ jobs:
         run: git checkout --progress --force ${{ github.sha }}
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+        uses: gradle/actions/wrapper-validation@v3
 
       - name: Setup JDK 17
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v4
         with:
+          distribution: 'zulu'
           java-version: '17'
           java-package: jdk+fx
 
@@ -47,4 +48,4 @@ jobs:
         if: always() && runner.os == 'Windows'
         working-directory:  ${{ github.workspace }}/text-ui-test
         shell: cmd
-        run: runtest.bat
+        run: runtest.bat

.gitignore

@@ -3,6 +3,8 @@
 /out/
 /*.iml
 
+*.class
+
 # Gradle build files
 /.gradle/
 /build/
@@ -15,3 +17,7 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+bookkeeper.log
+bookkeeper.log.lck
+/data/bookKeeper_bookList.txt
+/data/bookKeeper_loanList.txt

README.md

@@ -1,30 +1,14 @@
-# Duke project template
+# BookKeeper project template
 
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
+BookKeeper is a Command Line Interface (CLI) library manager application for effective tracking of library loans and inventory. It allows users to manage books, loans, and notes efficiently through a set of commands.
 
 ## Setting up in Intellij
 
 Prerequisites: JDK 17 (use the exact version), update Intellij to the most recent version.
 
 1. **Ensure Intellij JDK 17 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 17 in a previous Intellij project.
-1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the setup**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
-   ```
-   > Task :compileJava
-   > Task :processResources NO-SOURCE
-   > Task :classes
-
-   > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
-   What is your name?
-   ```
-   Type some word and press enter to let the execution proceed to the end.
+2. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
+3. **Verify the setup**: After the importing is complete, locate the `src/main/java/BookKeeper.java` file, right-click it, and choose `Run BookKeeper.main()`.
 
 **Warning:** Keep the `src\main\java` folder as the root folder for Java files (i.e., don't rename those folders or move Java files to another folder outside of this folder path), as this is the default location some tools (e.g., Gradle) expect to find Java files.
 
@@ -41,7 +25,7 @@ Prerequisites: JDK 17 (use the exact version), update Intellij to the most recen
 
 ### JUnit tests
 
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
+* A skeleton JUnit test (`src/test/java/DukeTest.java`) is provided with this project template. 
 * If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
 
 ## Checkstyle

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("bookkeeper.BookKeeper")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("BookKeeper")
     archiveClassifier.set("")
 }
 
@@ -42,5 +42,6 @@ checkstyle {
 }
 
 run{
+    enableAssertions = true
     standardInput = System.in
 }

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+| Display                                             |      Name      |             Github Profile             |              Portfolio              |
+|-----------------------------------------------------|:--------------:| :------------------------------------: |:-----------------------------------:|
+| ![](images/Portrait_placeholder.png)                |   Dylan Khoo   | [Github](https://github.com/dylankhoo) |   [Portfolio](team/dylankhoo.md)    |
+| ![](images/Portrait_placeholder.png) | Chan Sheng Bin | [Github](https://github.com/ShengBin-101) |  [Portfolio](team/shengbin-101.md)  |
+ ![](images/Portrait_placeholder.png) | Phua Lock Hian | [Github](https://github.com/phua-lock-hian) | [Portfolio](team/phua-lock-hian.md) |
+ ![](images/Portrait_placeholder.png) | Kam Sheng Jie  | [Github](https://github.com/ShengJie13245) | [Portfolio](team/shengjie13245.md)  
+