[CS2113-F13-2] BrokeMan

.gitignore

@@ -2,12 +2,13 @@
 /.idea/
 /out/
 /*.iml
-
 # Gradle build files
 /.gradle/
 /build/
 src/main/resources/docs/
-
+# Any other files that should not be committed
+/data
+*.jar
 # MacOS custom attributes files created by Finder
 .DS_Store
 *.iml

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.brokeMan.BrokeMan
+

README.md

@@ -1,64 +1,27 @@
-# Duke project template
+# BrokeMan
 
-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.
+```
+$$$$$___ ______ _______ $$_____ _______ $$___$$_ _______ _______
+$$__$$__ ______ _______ $$__$$_ _$$$$__ $$$_$$$_ $$$$$__ _______
+$$$$$___ $$_$$_ _$$$$__ $$_$$__ $$__$$_ $$$$$$$_ ____$$_ $$$$$__
+$$___$$_ $$$_$_ $$__$$_ $$$$___ $$$$$$_ $$_$_$$_ _$$$$$_ $$__$$_
+$$___$$_ $$____ $$__$$_ $$_$$__ $$_____ $$___$$_ $$__$$_ $$__$$_
+$$$$$$__ $$____ _$$$$__ $$__$$_ _$$$$$_ $$___$$_ _$$$$$_ $$__$$_
+```
 
-## Setting up in Intellij
+Welcome to BrokeMan!
 
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
+Your personal budget manager to prevent you to become broke like me...
 
-1. **Ensure Intellij JDK 11 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 11 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 set up**: 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.
+If you are a fast typer, this CLI based program will help you track your financial status much faster than the traditional UI based apps!
 
-## Build automation using Gradle
+---
 
-* This project uses Gradle for build automation and dependency management. It includes a basic build script as well (i.e. the `build.gradle` file).
-* If you are new to Gradle, refer to the [Gradle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/gradle.html).
-
-## Testing
-
-### I/O redirection tests
-
-* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script.
-
-### JUnit tests
-
-* A skeleton JUnit test (`src/test/java/seedu/duke/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
-
-* A sample CheckStyle rule configuration is provided in this project.
-* If you are new to Checkstyle, refer to the [Checkstyle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/checkstyle.html).
-
-## CI using GitHub Actions
-
-The project uses [GitHub actions](https://github.com/features/actions) for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR.
-
-## Documentation
-
-`/docs` folder contains a skeleton version of the project documentation.
-
-Steps for publishing documentation to the public: 
-1. If you are using this project template for an individual project, go your fork on GitHub.<br>
-   If you are using this project template for a team project, go to the team fork on GitHub.
-1. Click on the `settings` tab.
-1. Scroll down to the `GitHub Pages` section.
-1. Set the `source` as `master branch /docs folder`.
-1. Optionally, use the `choose a theme` button to choose a theme for your documentation.
+Useful links:
+* [User Guide](docs/UserGuide.md)
+* [Developer Guide](docs/DeveloperGuide.md)
+* [About Us](docs/AboutUs.md)
+* [Yu Sichen Sistine PPP](docs/team/sistine-yu.md)
+* [Sangjun Nam PPP](docs/team/namsengi11.md)
+* [Samuel Tan PPP](docs/team/samueltansw.md)
+* [Liam PPP](docs/team/speciliam.md)

build.gradle

@@ -1,46 +1,47 @@
-plugins {
-    id 'java'
-    id 'application'
-    id 'checkstyle'
-    id 'com.github.johnrengelman.shadow' version '7.1.2'
-}
-
-repositories {
-    mavenCentral()
-}
-
-dependencies {
-    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
-    testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
-}
-
-test {
-    useJUnitPlatform()
-
-    testLogging {
-        events "passed", "skipped", "failed"
-
-        showExceptions true
-        exceptionFormat "full"
-        showCauses true
-        showStackTraces true
-        showStandardStreams = false
-    }
-}
-
-application {
-    mainClass = "seedu.duke.Duke"
-}
-
-shadowJar {
-    archiveBaseName = "duke"
-    archiveClassifier = null
-}
-
-checkstyle {
-    toolVersion = '10.2'
-}
-
-run{
-    standardInput = System.in
-}
+plugins {
+    id 'java'
+    id 'application'
+    id 'checkstyle'
+    id 'com.github.johnrengelman.shadow' version '7.1.2'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
+    testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
+}
+
+test {
+    useJUnitPlatform()
+
+    testLogging {
+        events "passed", "skipped", "failed"
+
+        showExceptions true
+        exceptionFormat "full"
+        showCauses true
+        showStackTraces true
+        showStandardStreams = false
+    }
+}
+
+application {
+    mainClass = "seedu.brokeMan.BrokeMan"
+}
+
+shadowJar {
+    archiveBaseName = "brokeMan"
+    archiveClassifier = null
+}
+
+checkstyle {
+    toolVersion = '10.2'
+}
+
+run{
+    standardInput = System.in
+    enableAssertions = true
+}

docs/AboutUs.md

@@ -1,9 +1,8 @@
-# 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)
+# About us
+
+| Display                      |        Name        |        Github Profile         |             Portfolio              |
+|------------------------------|:------------------:|:-----------------------------:|:----------------------------------:|
+| <img src="./teamImages/A.jpg" width="500">   |      Yu Sichen     | [Github](https://github.com/sistine-yu) | [Portfolio](./team/sistine-yu.md)  |
+| <img src="./teamImages/B.jpg" width="500">      |      Liam Van      | [Github](https://github.com/SpeciLiam) |  [Portfolio](./team/speciliam.md)  |
+| ![](./teamImages/samuel.jpg) | Samuel Tan Sze Wee | [Github](https://github.com/Samueltansw) | [Portfolio](./team/samueltansw.md) |
+| <img src="./teamImages/Sangjun%20Nam.jpg" width="500">     |     Sangjun Nam    | [Github](https://github.com/namsengi11) | [Portfolio](./team/namsengi11.md)  |