Skip to content

Commit 6eab423

Browse files
committed
feat(3-1): add base
1 parent ae0c731 commit 6eab423

23 files changed

+571
-0
lines changed
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
9+
[*.java]
10+
indent_size = 4
11+
indent_style = space
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Gradle
2+
.gradle
3+
build/
4+
5+
# Ignore Gradle GUI config
6+
gradle-app.setting
7+
8+
var/log/*
9+
!var/log/.gitkeep
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.PHONY: all
2+
all: build
3+
4+
.PHONY: build
5+
build:
6+
@./gradlew assemble --warning-mode all
7+
8+
.PHONY: test
9+
test:
10+
@./gradlew check --warning-mode all
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<p align="center">
2+
<a href="https://codely.com">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="https://codely.com/logo/codely_logo-dark.svg">
5+
<source media="(prefers-color-scheme: light)" srcset="https://codely.com/logo/codely_logo-light.svg">
6+
<img alt="Codely logo" src="https://codely.com/logo/codely_logo.svg">
7+
</picture>
8+
</a>
9+
</p>
10+
11+
<h1 align="center">
12+
☕🚀 Java Basic Skeleton: Save the boilerplate in your new projects
13+
</h1>
14+
15+
<p align="center">
16+
<a href="https://github.com/CodelyTV"><img src="https://img.shields.io/badge/Codely-OS-green.svg?style=flat-square" alt="Codely Open Source projects"/></a>
17+
<a href="https://pro.codely.com"><img src="https://img.shields.io/badge/Codely-Pro-black.svg?style=flat-square" alt="Codely Pro courses"/></a>
18+
<a href="https://github.com/CodelyTV/java-basic-skeleton/actions"><img src="https://github.com/CodelyTV/java-basic-skeleton/workflows/Main%20Workflow/badge.svg" alt="Workflow Status"></a>
19+
</p>
20+
21+
22+
> ⚡ Start your Java projects as fast as possible
23+
24+
## ℹ️ Introduction
25+
26+
This is a repository intended to serve as a starting point if you want to bootstrap a Java project with JUnit and Gradle.
27+
28+
## 🏁 How To Start
29+
30+
1. Install Java: `brew install corretto` or download it [here](https://docs.aws.amazon.com/corretto/)
31+
2. Set it as your default JVM: `export JAVA_HOME='/Library/Java/JavaVirtualMachines/amazon-corretto-$JAVA_VERSION$.jdk/Contents/Home'`
32+
3. Clone this repository: `git clone https://github.com/CodelyTV/java-basic-skeleton`.
33+
4. Execute some [Gradle lifecycle tasks](https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks) in order to check everything is OK:
34+
1. Create [the project JAR](https://docs.gradle.org/current/userguide/java_plugin.html#sec:jar): `make build`
35+
2. Run the tests and plugins verification tasks: `make test`
36+
5. Start developing!
37+
38+
## ☝️ How to update dependencies
39+
40+
* Gradle (current version: 8.9 - [releases](https://gradle.org/releases/)):
41+
`./gradlew wrapper --gradle-version=8.9 --distribution-type=bin` or modifying the [gradle-wrapper.properties](gradle/wrapper/gradle-wrapper.properties#L3)
42+
* JUnit (current version: 5.8.2 - [releases](https://junit.org/junit5/docs/snapshot/release-notes/index.html)): [`build.gradle:14`](build.gradle#L14-L15)
43+
44+
## 💡 Related repositories
45+
46+
### ☕ Java
47+
48+
* 📂 [Java Basic Skeleton](https://github.com/CodelyTV/java-basic-skeleton)
49+
*[Java OOP Examples](https://github.com/CodelyTV/java-oop-examples)
50+
* 🧱 [Java SOLID Examples](https://github.com/CodelyTV/java-solid-examples)
51+
* 🥦 [Java DDD Example](https://github.com/CodelyTV/java-ddd-example)
52+
53+
### 🐘 PHP
54+
55+
* 📂 [PHP Basic Skeleton](https://github.com/CodelyTV/php-basic-skeleton)
56+
* 🎩 [PHP DDD Skeleton](https://github.com/CodelyTV/php-ddd-skeleton)
57+
* 🥦 [PHP DDD Example](https://github.com/CodelyTV/php-ddd-example)
58+
59+
### 🧬 Scala
60+
61+
* 📂 [Scala Basic Skeleton](https://github.com/CodelyTV/scala-basic-skeleton)
62+
*[Scala Basic Skeleton (g8 template)](https://github.com/CodelyTV/scala-basic-skeleton.g8)
63+
*[Scala Examples](https://github.com/CodelyTV/scala-examples)
64+
* 🥦 [Scala DDD Example](https://github.com/CodelyTV/scala-ddd-example)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
apply plugin: 'java'
2+
3+
sourceCompatibility = 21
4+
targetCompatibility = 21
5+
6+
repositories {
7+
mavenCentral()
8+
}
9+
10+
dependencies {
11+
implementation 'org.apache.logging.log4j:log4j-core:2.17.0'
12+
implementation 'com.vlkan.log4j2:log4j2-logstash-layout:1.0.5'
13+
14+
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.2'
15+
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.2'
16+
}
17+
18+
test {
19+
useJUnitPlatform()
20+
21+
testLogging {
22+
events "passed", "skipped", "failed"
23+
}
24+
}
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
4+
networkTimeout=10000
5+
validateDistributionUrl=true
6+
zipStoreBase=GRADLE_USER_HOME
7+
zipStorePath=wrapper/dists
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
#!/bin/sh
2+
3+
#
4+
# Copyright © 2015-2021 the original authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
# SPDX-License-Identifier: Apache-2.0
19+
#
20+
21+
##############################################################################
22+
#
23+
# Gradle start up script for POSIX generated by Gradle.
24+
#
25+
# Important for running:
26+
#
27+
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
28+
# noncompliant, but you have some other compliant shell such as ksh or
29+
# bash, then to run this script, type that shell name before the whole
30+
# command line, like:
31+
#
32+
# ksh Gradle
33+
#
34+
# Busybox and similar reduced shells will NOT work, because this script
35+
# requires all of these POSIX shell features:
36+
# * functions;
37+
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
38+
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
39+
# * compound commands having a testable exit status, especially «case»;
40+
# * various built-in commands including «command», «set», and «ulimit».
41+
#
42+
# Important for patching:
43+
#
44+
# (2) This script targets any POSIX shell, so it avoids extensions provided
45+
# by Bash, Ksh, etc; in particular arrays are avoided.
46+
#
47+
# The "traditional" practice of packing multiple parameters into a
48+
# space-separated string is a well documented source of bugs and security
49+
# problems, so this is (mostly) avoided, by progressively accumulating
50+
# options in "$@", and eventually passing that to Java.
51+
#
52+
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
53+
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
54+
# see the in-line comments for details.
55+
#
56+
# There are tweaks for specific operating systems such as AIX, CygWin,
57+
# Darwin, MinGW, and NonStop.
58+
#
59+
# (3) This script is generated from the Groovy template
60+
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
61+
# within the Gradle project.
62+
#
63+
# You can find Gradle at https://github.com/gradle/gradle/.
64+
#
65+
##############################################################################
66+
67+
# Attempt to set APP_HOME
68+
69+
# Resolve links: $0 may be a link
70+
app_path=$0
71+
72+
# Need this for daisy-chained symlinks.
73+
while
74+
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
75+
[ -h "$app_path" ]
76+
do
77+
ls=$( ls -ld "$app_path" )
78+
link=${ls#*' -> '}
79+
case $link in #(
80+
/*) app_path=$link ;; #(
81+
*) app_path=$APP_HOME$link ;;
82+
esac
83+
done
84+
85+
# This is normally unused
86+
# shellcheck disable=SC2034
87+
APP_BASE_NAME=${0##*/}
88+
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
89+
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
90+
' "$PWD" ) || exit
91+
92+
# Use the maximum available, or set MAX_FD != -1 to use that value.
93+
MAX_FD=maximum
94+
95+
warn () {
96+
echo "$*"
97+
} >&2
98+
99+
die () {
100+
echo
101+
echo "$*"
102+
echo
103+
exit 1
104+
} >&2
105+
106+
# OS specific support (must be 'true' or 'false').
107+
cygwin=false
108+
msys=false
109+
darwin=false
110+
nonstop=false
111+
case "$( uname )" in #(
112+
CYGWIN* ) cygwin=true ;; #(
113+
Darwin* ) darwin=true ;; #(
114+
MSYS* | MINGW* ) msys=true ;; #(
115+
NONSTOP* ) nonstop=true ;;
116+
esac
117+
118+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
119+
120+
121+
# Determine the Java command to use to start the JVM.
122+
if [ -n "$JAVA_HOME" ] ; then
123+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
124+
# IBM's JDK on AIX uses strange locations for the executables
125+
JAVACMD=$JAVA_HOME/jre/sh/java
126+
else
127+
JAVACMD=$JAVA_HOME/bin/java
128+
fi
129+
if [ ! -x "$JAVACMD" ] ; then
130+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
131+
132+
Please set the JAVA_HOME variable in your environment to match the
133+
location of your Java installation."
134+
fi
135+
else
136+
JAVACMD=java
137+
if ! command -v java >/dev/null 2>&1
138+
then
139+
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
140+
141+
Please set the JAVA_HOME variable in your environment to match the
142+
location of your Java installation."
143+
fi
144+
fi
145+
146+
# Increase the maximum file descriptors if we can.
147+
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
148+
case $MAX_FD in #(
149+
max*)
150+
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
151+
# shellcheck disable=SC2039,SC3045
152+
MAX_FD=$( ulimit -H -n ) ||
153+
warn "Could not query maximum file descriptor limit"
154+
esac
155+
case $MAX_FD in #(
156+
'' | soft) :;; #(
157+
*)
158+
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
159+
# shellcheck disable=SC2039,SC3045
160+
ulimit -n "$MAX_FD" ||
161+
warn "Could not set maximum file descriptor limit to $MAX_FD"
162+
esac
163+
fi
164+
165+
# Collect all arguments for the java command, stacking in reverse order:
166+
# * args from the command line
167+
# * the main class name
168+
# * -classpath
169+
# * -D...appname settings
170+
# * --module-path (only if needed)
171+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
172+
173+
# For Cygwin or MSYS, switch paths to Windows format before running java
174+
if "$cygwin" || "$msys" ; then
175+
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
176+
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
177+
178+
JAVACMD=$( cygpath --unix "$JAVACMD" )
179+
180+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
181+
for arg do
182+
if
183+
case $arg in #(
184+
-*) false ;; # don't mess with options #(
185+
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
186+
[ -e "$t" ] ;; #(
187+
*) false ;;
188+
esac
189+
then
190+
arg=$( cygpath --path --ignore --mixed "$arg" )
191+
fi
192+
# Roll the args list around exactly as many times as the number of
193+
# args, so each arg winds up back in the position where it started, but
194+
# possibly modified.
195+
#
196+
# NB: a `for` loop captures its iteration list before it begins, so
197+
# changing the positional parameters here affects neither the number of
198+
# iterations, nor the values presented in `arg`.
199+
shift # remove old arg
200+
set -- "$@" "$arg" # push replacement arg
201+
done
202+
fi
203+
204+
205+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
206+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
207+
208+
# Collect all arguments for the java command:
209+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
210+
# and any embedded shellness will be escaped.
211+
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
212+
# treated as '${Hostname}' itself on the command line.
213+
214+
set -- \
215+
"-Dorg.gradle.appname=$APP_BASE_NAME" \
216+
-classpath "$CLASSPATH" \
217+
org.gradle.wrapper.GradleWrapperMain \
218+
"$@"
219+
220+
# Stop when "xargs" is not available.
221+
if ! command -v xargs >/dev/null 2>&1
222+
then
223+
die "xargs is not available"
224+
fi
225+
226+
# Use "xargs" to parse quoted args.
227+
#
228+
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
229+
#
230+
# In Bash we could simply go:
231+
#
232+
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
233+
# set -- "${ARGS[@]}" "$@"
234+
#
235+
# but POSIX shell has neither arrays nor command substitution, so instead we
236+
# post-process each arg (as a line of input to sed) to backslash-escape any
237+
# character that might be a shell metacharacter, then use eval to reverse
238+
# that process (while maintaining the separation between arguments), and wrap
239+
# the whole thing up as a single "set" statement.
240+
#
241+
# This will of course break if any of these variables contains a newline or
242+
# an unmatched quote.
243+
#
244+
245+
eval "set -- $(
246+
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
247+
xargs -n1 |
248+
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
249+
tr '\n' ' '
250+
)" '"$@"'
251+
252+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)