Noel

.github/workflows/github-actions.yml

@@ -0,0 +1,22 @@
+name: GitHub Actions Demo
+on: [push]
+jobs:
+  Explore-GitHub-Actions:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Environment
+        run: |
+            echo "Event - ${{ github.event_name }}"
+            echo "Runner ${{ runner.os }}"
+            echo "The name of your branch - ${{ github.repository }}/${{ github.ref }}"
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: Install JDK
+        uses: actions/setup-java@v2
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - name: Run deployment test using maven
+        run: .github/workflows/run-deployment-test.sh
+      - name: After run status
+        run: echo "🍏 This job's status is ${{ job.status }}."

.github/workflows/run-deployment-test.sh

@@ -0,0 +1,42 @@
+#!/bin/sh
+
+# clean build dir
+rm -rf target
+
+
+curl -sL https://www-eu.apache.org/dist/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.zip -o maven.zip
+sudo apt-get update
+sudo apt-get -y install unzip
+unzip -d /usr/share maven.zip
+rm maven.zip
+
+mvnlnk=/usr/bin/mvn
+if [ ! -L $(mvnlnk) ]; then
+  sudo rm $(mvnlnk)
+fi
+
+sudo ln -s /usr/share/apache-maven-3.6.3/bin/mvn /usr/bin/mvn
+echo "M2_HOME=/usr/share/apache-maven-3.6.3" | sudo tee -a /etc/environment
+
+# source code test
+mvn clean
+mvn install
+mvn compile
+mvn test
+
+# package into jar
+mvn package
+# test jar output
+java -jar NoelLim/Duke.jar < ./src/test/resources/linux-test/input.txt > ./src/test/resources/linux-test/actual.txt
+
+cmp --print-chars ./src/test/resources/linux-test/actual.txt ./src/test/resources/linux-test/expected.txt
+if [ $? -eq 0 ]
+then
+    echo "Test result: PASSED"
+    exit 0
+else
+    cat ./src/test/resources/linux-test/actual.txt
+    cat ./src/test/resources/linux-test/expected.txt
+    echo "Test result: FAILED"
+    exit 1
+fi

.gitignore

@@ -2,16 +2,29 @@
 /.idea/
 /out/
 /*.iml
+/lib
 
 # Gradle build files
 /.gradle/
 /build/
 src/main/resources/docs/
 
+# Maven build files
+/NoelLim
+/target
+
 # MacOS custom attributes files created by Finder
 .DS_Store
 *.iml
 bin/
 
+# Generated files
+/src/main/resources/*
+!/src/main/resources/data/*
+
+# Test
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+/src/test/resources/generated/*
+/src/test/resources/test-output/actual.txt
+/src/test/resources/linux-test

README.md

@@ -1,24 +1,61 @@
-# Duke 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.
-
-## Setting up in Intellij
-
-Prerequisites: JDK 11, update Intellij to the most recent version.
-
-1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
-1. Open the project into Intellij as follows:
-   1. Click `Open`.
-   1. Select the project directory, and click `OK`.
-   1. If there are any further prompts, accept the defaults.
-1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
-   In the same dialog, set the **Project language level** field to the `SDK default` option.
-3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+![](./docs/logo.png)
+
+# Duke
+A cli-chatbot task manager.
+
+# Requirements
+
+For production you will need JDK 11 support and maven for build. Source code is tested on Linux/Catalina.
+
+# Run
+
+Clone the repo.
+
+## Test
+
+### With Local Github Action
+```act``` test
+
+### With Maven
+
+```mvn test```
+
+### Build
+
+In root of repository,
+
+```mvn package``` package \
+```./NoelLim/Duke.jar``` generated jar is single executable fatty \
+```java -jar ./NoelLim/Duke.jar``` run jar
+
+# Command List
+
+`[*]`   - unknown command
+
+`todo [description]` add ToDo \
+`deadline [description] /by [date:dateOption]` add Deadline \
+`event [description] /at [from:dateOption]-[to:dateOption]` add Event
+
+- dateOption formats
+    - Input year, month and day : "20201231"
+    - Input year, month, day, hour, minutes : "20201231 23:59"
+
+`delete [id]` delete task by id \
+`done [id]` set task as done \
+`undone [id]` set task as not done
+
+`see [id]` see task
+
+`list` list tasks \
+`find [keyword]` query tasks with keyword in description
+
+`stats:all` summary of tasks
+
+`projection [days]` projection for next days \
+`projection:yet [days]` projection for next days (only show incomplete tasks)
+
+`scan:duplicates` check for tasks with same description
+
+`bye` exit input loop \
+`save` save tasks to file
+