[CS2113-T13-1] MoneyMoover

.github/pull_request_template.md

@@ -0,0 +1,78 @@
+<!--  This PR Template is taken with inspiration from kubernetes's open source repo: https://github.com/kubernetes/kubernetes/blob/master/.github/PULL_REQUEST_TEMPLATE.md
+-->
+
+# Description
+
+<!--- Please include a short summary of the change -->
+
+## Type of Change
+
+- [ ] Possible breaking change (Change in feature that may cause existing features to not work correctly, e.g. change in
+  schema)
+- [ ] Non breaking change (Bug fix, New feature)
+
+## What type of PR is this?
+
+<!--
+Add one of the following kinds:
+- Bug Fix
+- Clean Up
+- Documentation
+- Feature
+-->
+
+- [ ] bug fix
+- [ ] cleanup
+- [ ] documentation
+- [ ] feature
+
+## What this PR does / Why we need it:
+
+```docs
+
+```
+
+## Which issue(s) this PR fixes, if:
+
+<!--
+*Automatically closes linked issue when PR is merged.
+Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
+keywords:
+- `close`
+- `closes`
+- `closed`
+- `fix`
+- `fixes`
+- `fixed`
+- `resolve`
+- `resolves`
+- `resolved`
+-->
+
+Fixes #
+
+## Special notes for your reviewer:
+
+#### Additional documentation e.g., usage docs, testing docs etc.:
+
+<!--
+This section can be blank if this pull request does not require a release note.
+When adding links which point to resources within git repositories, like the
+supporting documentations, please reference a specific commit and avoid
+linking directly to the master branch. This ensures that links reference a
+specific point in time, rather than a document that may change over time.
+See here for guidance on getting permanent links to files: https://help.github.com/en/articles/getting-permanent-links-to-files
+Please use the following format for linking documentation:
+- [Usage]: <link>
+- [Other doc]: <link>
+-->
+
+```docs
+
+```
+
+## Checklist
+
+- [ ] Changes have been tested
+- [ ] All automated tests pass
+- [ ] Relevant Tags and Milestones have been added

.github/workflows/gradle.yml

@@ -33,18 +33,18 @@ jobs:
       - name: Build and check with Gradle
         run: ./gradlew check
 
-      - name: Perform IO redirection test (*NIX)
-        if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (MacOS)
-        if: always() && runner.os == 'macOS'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (Windows)
-        if: always() && runner.os == 'Windows'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        shell: cmd
-        run: runtest.bat
+#      - name: Perform IO redirection test (*NIX)
+#        if: runner.os == 'Linux'
+#        working-directory:  ${{ github.workspace }}/text-ui-test
+#        run: ./runtest.sh
+#
+#      - name: Perform IO redirection test (MacOS)
+#        if: always() && runner.os == 'macOS'
+#        working-directory:  ${{ github.workspace }}/text-ui-test
+#        run: ./runtest.sh
+#
+#      - name: Perform IO redirection test (Windows)
+#        if: always() && runner.os == 'Windows'
+#        working-directory:  ${{ github.workspace }}/text-ui-test
+#        shell: cmd
+#        run: runtest.bat

.gitignore

@@ -15,3 +15,7 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+data/
+log.txt
+log.txt.lck

DefaultCodeStyle.xml

@@ -0,0 +1,6 @@
+<code_scheme name="Default" version="173">
+  <codeStyleSettings language="JAVA">
+    <option name="INDENT_CASE_FROM_SWITCH" value="false" />
+    <option name="SPACE_BEFORE_METHOD_PARENTHESES" value="true" />
+  </codeStyleSettings>
+</code_scheme>

README.md

@@ -1,64 +1,15 @@
-# Duke project template
+# MoneyMoover
 
-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.
+MoneyMoover is a **CLI application for managing and transferring international currencies**, optimized for use via a
+Command Line Interface (CLI)
+while still having the features of other money management applications.
 
-## Setting up in Intellij
+Our app will help students to **track their expenses and income** in order to stay within their budgets, so that they
+have enough money to travel.
+It will also help them convert to foreign currencies so they can see how much they have to spend overseas.
 
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
+Useful links:
 
-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.
-
-## 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.
+* [User Guide](docs/UserGuide.md)
+* [Developer Guide](docs/DeveloperGuide.md)
+* [About Us](docs/AboutUs.md)

build.gradle

@@ -12,6 +12,9 @@ repositories {
 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'
+    implementation 'com.squareup.retrofit2:retrofit:2.7.0'
+    implementation 'com.squareup.retrofit2:converter-gson:2.7.0'
+    implementation 'com.google.code.gson:gson:2.10.1'
 }
 
 test {
@@ -29,18 +32,18 @@ test {
 }
 
 application {
-    mainClass = "seedu.duke.Duke"
+    mainClass = "com.moneymoover.MoneyMoover"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "moneymoover"
     archiveClassifier = null
 }
 
 checkstyle {
     toolVersion = '10.2'
 }
 
-run{
+run {
     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/Arif-Photo.jpg)    |  Arif Khalid  | [Github](https://github.com/arif-khalid)  | [Portfolio](team/arif-khalid.md)  |
+| ![](images\Gan-Zhen-Yang.jpg) | Gan Zhen Yang |  [Github](https://github.com/gan868611)   |  [Portfolio](team/gan868611.md)   |
+| ![](images/Benjamin.jpeg)     | Benjamin Long |    [Github](https://github.com/bawfen)    |    [Portfolio](team/bawfen.md)    |
+| ![](images/wenjun.jpg)        |  Woo Wen Jun  | [Github](https://github.com/woowenjun99)  | [Portfolio](team/woowenjun99.md)  |
+| ![](images/Jacob-Stein.jpg)   |  Jacob Stein  | [Github](https://github.com/jacob-stein1) | [Portfolio](team/jacob-stein1.md) |