[CS2113-T15-1] LongAh!

.gitignore

@@ -13,5 +13,9 @@ src/main/resources/docs/
 *.iml
 bin/
 
-/text-ui-test/ACTUAL.TXT
-text-ui-test/EXPECTED-UNIX.TXT
+ACTUAL*.TXT
+EXPECTED*-UNIX.TXT
+
+.vscode/
+data/
+log/

README.md

@@ -1,64 +1,22 @@
-# Duke project template
+# Long Ah!
 
-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.
+![LongAh logo.jpg](docs%2Fdiagrams%2FLongAh%20logo.jpg)
 
-## Setting up in Intellij
+## Introduction
 
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
+LongAh! is a CLI-based application designed to help users track debts within friend groups and determine the
+least transaction method of settling these debts. It is optimized for busy people with large transaction quantities
+among friends.
 
-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.
+## Quick Start
 
-## 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.
+1. Ensure that you have Java 11 or above installed.
+2. Download the latest version of `LongAh!` from [here](https://github.com/AY2324S2-CS2113-T15-1/tp/releases).
+3. Copy the JAR file to the folder you want to use as the home folder for your LongAh! application.
+4. Open a command terminal, navigate to the folder containing the JAR file and run the command:
+```
+java -jar tp.jar
+```
+5. Upon starting the application, you will be prompted to enter your PIN. The user PIN is required to access the application.
+   The app will prompt you to create your own PIN if it is your first time using the application.
+6. You can now start using LongAh! by entering commands into the command terminal.

build.gradle

@@ -12,6 +12,7 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
+    implementation 'org.knowm.xchart:xchart:3.8.1'
 }
 
 test {
@@ -29,11 +30,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("longah.LongAh")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("longah")
     archiveClassifier.set("")
 }
 
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -2,8 +2,8 @@
 
 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)
+![](https://via.placeholder.com/100.png?text=Photo) | Leong Deng Jun | [Github](https://github.com/djleong01) | [Portfolio](team/djleong01.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Sim Justin | [Github](https://github.com/1simjustin) | [Portfolio](team/1simjustin.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Chew Jing Xiang | [Github](https://github.com/jing-xiang) | [Portfolio](team/jing-xiang.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Liao Jingyu | [Github](https://github.com/FeathersRe) | [Portfolio](team/feathersre.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Wu Hao Wern | [Github](https://github.com/haowern98) | [Portfolio](team/haowern98.md)