Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[tijngsheng] ip #526

Open
wants to merge 67 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
1bae5ec
add-duke-level-0
tjingsheng Aug 24, 2023
367f7f7
add-duke-level-1
tjingsheng Aug 24, 2023
a2c4dd9
add-duke-level-2
tjingsheng Aug 24, 2023
528a9e7
add-duke-level-3
tjingsheng Aug 24, 2023
ec387ca
add-duke-level-4
tjingsheng Aug 26, 2023
0a7157d
add-duke-level-5
tjingsheng Sep 2, 2023
159dce2
add-a-textuitesting
tjingsheng Sep 2, 2023
8a21be3
add-duke-level-6
tjingsheng Sep 2, 2023
5591af6
add-a-enums
tjingsheng Sep 2, 2023
22d8c9f
change-readme
tjingsheng Sep 3, 2023
ad20070
Merge pull request #1 from tjingsheng/add-intro
tjingsheng Sep 3, 2023
6eaed36
add-duke-level-7
tjingsheng Sep 3, 2023
1dca124
Merge pull request #2 from tjingsheng/branch-Level-7
tjingsheng Sep 3, 2023
b5bbeb3
add-duke-level-8
tjingsheng Sep 3, 2023
4afef36
Merge pull request #3 from tjingsheng/branch-level-8
tjingsheng Sep 3, 2023
9639880
add-a-moreoop
tjingsheng Sep 3, 2023
ccc67b1
Merge pull request #4 from tjingsheng/a-more-oop
tjingsheng Sep 3, 2023
c73781b
add-a-gradle
tjingsheng Sep 3, 2023
486f643
Merge pull request #5 from tjingsheng/add-a-gradle
tjingsheng Sep 3, 2023
776fc02
add-a-junit
tjingsheng Sep 5, 2023
426c9aa
add-a-jar
tjingsheng Sep 5, 2023
b92c5ba
Merge branch 'master' into add-a-jar
tjingsheng Sep 5, 2023
06432f2
Merge pull request #11 from tjingsheng/add-a-jar
tjingsheng Sep 5, 2023
1cb99a4
add-a-javadoc
tjingsheng Sep 5, 2023
443b1aa
add-a-codingstandard
tjingsheng Sep 5, 2023
c9d4407
add-duke-level-9
tjingsheng Sep 5, 2023
058da47
Merge pull request #12 from tjingsheng/branch-A-JavaDoc
tjingsheng Sep 5, 2023
224fb84
Merge branch 'master' into branch-A-CodingStandard
tjingsheng Sep 5, 2023
e1110ec
Merge pull request #13 from tjingsheng/branch-A-CodingStandard
tjingsheng Sep 5, 2023
3c3eda5
Merge branch 'master' into branch-Level-9
tjingsheng Sep 5, 2023
beebfa4
Merge pull request #14 from tjingsheng/branch-Level-9
tjingsheng Sep 5, 2023
e0ab0cc
use-gfmd-in-README
tjingsheng Sep 5, 2023
f0ce93c
add-duke-a-checkstyle
tjingsheng Sep 10, 2023
100a51d
Merge pull request #15 from tjingsheng/add-a-checkstyle
tjingsheng Sep 10, 2023
9909308
Merge pull request #15 from tjingsheng/add-a-checkstyle
tjingsheng Sep 10, 2023
025eee5
Merge branch 'master' of https://github.com/tjingsheng/ip
tjingsheng Sep 10, 2023
eeb0d26
add-duke-level-10
tjingsheng Sep 10, 2023
1e33057
Merge pull request #16 from tjingsheng/branch-Level-10
tjingsheng Sep 13, 2023
6d32bdc
add-missing-fonts
tjingsheng Sep 14, 2023
6593215
add-duke-level-10
tjingsheng Sep 10, 2023
cc48bb3
Merge branch 'master' into branch-Level-10
tjingsheng Sep 15, 2023
e7b0cc7
Merge pull request #17 from tjingsheng/branch-Level-10
tjingsheng Sep 15, 2023
062b43b
fix merge error
tjingsheng Sep 15, 2023
1aaa8a2
add-duke-level-10
tjingsheng Sep 15, 2023
2e9da59
Merge pull request #18 from tjingsheng/branch-Level-10
tjingsheng Sep 15, 2023
77e3e77
add-a-varargs
tjingsheng Sep 15, 2023
ee5b080
Merge pull request #19 from tjingsheng/add-a-varags
tjingsheng Sep 15, 2023
5e487f5
add-a-codequality
tjingsheng Sep 15, 2023
72e35b5
add-a-assertions
tjingsheng Sep 15, 2023
8724df1
Merge pull request #20 from tjingsheng/branch-A-CodeQuality
tjingsheng Sep 15, 2023
505107a
Merge branch 'master' into branch-A-Assertions
tjingsheng Sep 15, 2023
b9e8d3f
Merge pull request #21 from tjingsheng/branch-A-Assertions
tjingsheng Sep 15, 2023
a8390a0
Refactor based on Sharing iP code quality feedback
tjingsheng Sep 16, 2023
c20645e
add-bcd-extension
tjingsheng Sep 16, 2023
3689c59
Merge pull request #23 from tjingsheng/add-bcd-extension
tjingsheng Sep 17, 2023
96f4ecf
remove redundant test in bye command
tjingsheng Sep 17, 2023
7671e39
add-week-six
tjingsheng Sep 18, 2023
ee492bd
Merge pull request #24 from tjingsheng/add-week-six
tjingsheng Sep 18, 2023
82df297
fix-bugs
tjingsheng Sep 20, 2023
4e28cbc
Merge pull request #25 from tjingsheng/fix-bug
tjingsheng Sep 20, 2023
78e62bb
improve-application
tjingsheng Sep 20, 2023
7584e98
Merge pull request #26 from tjingsheng/improve-application
tjingsheng Sep 20, 2023
46aaf7a
Update and rename README.md to docs/GFMDPractice.md
tjingsheng Sep 22, 2023
5740129
Update README.md
tjingsheng Sep 22, 2023
df16c06
update-readme-ug
tjingsheng Sep 22, 2023
3180551
Merge pull request #27 from tjingsheng/update-readme-ug
tjingsheng Sep 22, 2023
ee94261
fix-build-gradle
tjingsheng Sep 23, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 72 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,72 @@
# 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
____ _
| _ \ _ _| | _____
| | | | | | | |/ / _ \
| |_| | |_| | < __/
|____/ \__,_|_|\_\___|
```
# Duke project
## Hello from
```
██╗██╗███╗ ██╗ ██████╗ ███████╗██╗ ██╗███████╗███╗ ██╗ ██████╗
██║██║████╗ ██║██╔════╝ ██╔════╝██║ ██║██╔════╝████╗ ██║██╔════╝
██║██║██╔██╗ ██║██║ ███╗ ███████╗███████║█████╗ ██╔██╗ ██║██║ ███╗
██ ██║██║██║╚██╗██║██║ ██║ ╚════██║██╔══██║██╔══╝ ██║╚██╗██║██║ ██║
╚█████╔╝██║██║ ╚████║╚██████╔╝ ███████║██║ ██║███████╗██║ ╚████║╚██████╔╝
╚════╝ ╚═╝╚═╝ ╚═══╝ ╚═════╝ ╚══════╝╚═╝ ╚═╝╚══════╝╚═╝ ╚═══╝ ╚═════╝
```
## Project Description
This is my project, created from a template for a greenfield Java project.
It's named after the Java mascot _Duke_.
This project is a Java application that aims to provide a user-friendly task management system. It allows users to manage their tasks efficiently and keep track of their schedules.

## Features

- **Task Creation**: Users can add various types of tasks, including todo, deadline, and event tasks.
- **Task List**: View a list of all tasks, including their descriptions and completion status.
- **Task Completion**: Mark tasks as complete when they are done.
- **Task Deletion**: Remove tasks that are no longer needed.
- **Task Searching**: Search for tasks based on keywords.
- **Data Storage**: Data is automatically saved and loaded for seamless usage.

## Installation Option 1

1. Go to tjingsheng ip [releases](https://github.com/tjingsheng/ip/releases)
2. **Get Java**: Ensure you have a functioning version of Java.
3. **Copy the JAR File**: Copy the JAR file you want to run into an empty folder.
4. **Open a Command Window**: Open a command prompt (Windows) or terminal (macOS/Linux) in the same folder where you copied the JAR file.
5. **Run the Command**: Use the following command to run the JAR file:
6. **Enjoy**: Duke is very fun.

```shell
java -jar duke.jar

## Installation Option 2

1. Clone the tjingsheng ip [repository](https://github.com/tjingshengg/ip) to your local machine.
2. Open the project in your preferred Java development environment.
3. Build and run the application.
4. Enjoy

## Todo List

- [x] Task 1 : Get duke
- [ ] Task 2 : Experiment with it
- [ ] Task 3 : Profit ???
- [ ] Task 4 : ~~Cry~~

## Project Sample
```
/**
* Runs the Duke application, allowing the user to interact with it via the command line.
*/
public static void runDuke() {
Scanner scanner = new Scanner(System.in);
Ui.helloWorld();
boolean isConversing = true;
while (isConversing) {
String rawCommand = Ui.getUserInput(scanner);
TaskList taskList = TaskFileHandler.readFromFile();
Ui.getBotMessage();
Command command = Parser.parse(rawCommand);
command.execute(taskList);
TaskFileHandler.saveToFile(taskList);
isConversing = !command.isByeCommand();
}
}
```

>>>>> "Duke hehe Duke hehe" - Jing Sheng
43 changes: 43 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
plugins {
id 'java'
id 'application'
id 'com.github.johnrengelman.shadow' version '7.1.2'
}

repositories {
mavenCentral()
}

dependencies {
implementation 'com.google.code.gson:gson:2.10.1'
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'
}

test {
useJUnitPlatform()

testLogging {
events "passed", "skipped", "failed"

showExceptions true
exceptionFormat "full"
showCauses true
showStackTraces true
showStandardStreams = false
}
}

application {
mainClass.set("duke.Duke")
}

shadowJar {
archiveBaseName = "duke"
archiveClassifier = null
dependsOn("distZip", "distTar")
}

run{
standardInput = System.in
}
7 changes: 7 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
248 changes: 248 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
#!/bin/sh

#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################

# Attempt to set APP_HOME

# Resolve links: $0 may be a link
app_path=$0

# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done

# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum

warn () {
echo "$*"
} >&2

die () {
echo
echo "$*"
echo
exit 1
} >&2

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar


# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
if ! command -v java >/dev/null 2>&1
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
fi

# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi

# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.

# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )

JAVACMD=$( cygpath --unix "$JAVACMD" )

# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi


# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.

set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"

# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi

# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#

eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'

exec "$JAVACMD" "$@"
Loading