Skip to content

Commit 279bc5e

Browse files
committed
Hello World!
1 parent f9529c1 commit 279bc5e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+4296
-0
lines changed

README.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
2+
<p align="center">
3+
<img src="https://i.imgur.com/RimtCzX.png" alt="dChat logo"/>
4+
</p>
5+
6+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/daymxn/dChat?style=flat-square)
7+
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/daymxn/dChat/master?style=flat-square)
8+
![GitHub issues](https://img.shields.io/github/issues/daymxn/dChat?style=flat-square)
9+
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/daymxn/dChat?style=flat-square)
10+
![GitHub](https://img.shields.io/github/license/daymxn/dChat?style=flat-square)
11+
# dChat
12+
13+
Desktop messaging platform, developed and designed completely in Kotlin!
14+
## Notable features
15+
16+
- Fully documented API
17+
- End-to-End markdown writeups
18+
- Industry standard practices
19+
- Functional and modular implementations
20+
- Clean and Readable code
21+
- Business layer testing
22+
23+
24+
## Roadmap
25+
26+
- Client implementation
27+
- Disconnect socket connections when JWT tokens expire
28+
- Notify online chats about users going offline
29+
30+
31+
## Documentation
32+
33+
[Datamodels](/src/main/kotlin/com/daymxn/dchat/datamodel/DATAMODELS.md)
34+
35+
[Routes](/src/main/kotlin/com/daymxn/dchat/routes/ROUTES.md)
36+
37+
[WebSockets](/src/main/kotlin/com/daymxn/dchat/routes/websockets/WEBSOCKETS.md)
38+
39+
[Services](/src/main/kotlin/com/daymxn/dchat/service/SERVICES.md)
40+
41+
[Tests](/src/test/TESTS.md)
42+
43+
## Contributing
44+
45+
Contributions are always welcome!
46+
47+
See [contributing.md](/contributing.md) for ways to get started.
48+
49+
## Running tests
50+
51+
To run tests, run the following with Gradle
52+
53+
```Bash
54+
./gradlew test
55+
```
56+
57+
## License
58+
59+
[Apache 2.0](/LICENSE)

build.gradle.kts

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
2+
3+
val ktorVersion: String by project
4+
val kotlinVersion: String by project
5+
val logbackVersion: String by project
6+
val exposedVersion: String by project
7+
val webSocketKtorVersion: String by project
8+
val kotestVersion: String by project
9+
val mockkVersion: String by project
10+
11+
plugins {
12+
application
13+
kotlin("jvm") version "1.6.20"
14+
kotlin("plugin.serialization") version "1.6.20"
15+
}
16+
17+
group = "com.daymxn"
18+
version = "1.0.0"
19+
application {
20+
mainClass.set("com.daymxn.ApplicationKt")
21+
22+
val isDevelopment: Boolean = project.ext.has("development")
23+
applicationDefaultJvmArgs = listOf("-Dio.ktor.development=$isDevelopment")
24+
}
25+
26+
tasks.withType<KotlinCompile>().configureEach {
27+
kotlinOptions.freeCompilerArgs += "-opt-in=io.ktor.locations.KtorExperimentalLocationsAPI"
28+
}
29+
30+
tasks.withType<Test>().configureEach {
31+
useJUnitPlatform()
32+
}
33+
34+
repositories {
35+
mavenCentral()
36+
maven {
37+
url = uri("https://maven.pkg.jetbrains.space/public/p/ktor/eap")
38+
name = "ktor-eap"
39+
}
40+
}
41+
42+
dependencies {
43+
implementation("ch.qos.logback:logback-classic:$logbackVersion")
44+
implementation("com.zaxxer:HikariCP:5.0.1")
45+
implementation("mysql:mysql-connector-java:8.0.28")
46+
47+
implementation("org.jetbrains.exposed:exposed-core:$exposedVersion")
48+
implementation("org.jetbrains.exposed:exposed-dao:$exposedVersion")
49+
implementation("org.jetbrains.exposed:exposed-jdbc:$exposedVersion")
50+
51+
implementation("io.ktor:ktor-server-content-negotiation-jvm:$ktorVersion")
52+
implementation("io.ktor:ktor-client-content-negotiation:$ktorVersion")
53+
implementation("io.ktor:ktor-serialization-kotlinx-json:$ktorVersion")
54+
implementation("io.ktor:ktor-server-core-jvm:$ktorVersion")
55+
implementation("io.ktor:ktor-server-websockets-jvm:$ktorVersion")
56+
implementation("io.ktor:ktor-server-auth-jvm:$ktorVersion")
57+
implementation("io.ktor:ktor-server-auth-jwt-jvm:$ktorVersion")
58+
implementation("io.ktor:ktor-server-sessions-jvm:$ktorVersion")
59+
implementation("io.ktor:ktor-server-cio-jvm:$ktorVersion")
60+
implementation("io.ktor:ktor-server-content-negotiation:$ktorVersion")
61+
implementation("io.ktor:ktor-server-resources:$ktorVersion")
62+
63+
testImplementation("io.kotest:kotest-runner-junit5:$kotestVersion")
64+
testImplementation("io.kotest:kotest-assertions-core:$kotestVersion")
65+
testImplementation("io.ktor:ktor-server-tests-jvm:$ktorVersion")
66+
testImplementation("io.ktor:ktor-server-test-host:$ktorVersion")
67+
testImplementation("io.mockk:mockk:$mockkVersion")
68+
}

contributing.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing
2+
3+
Any and all contributions are entirely welcomed! Before you contribute though, there are
4+
some things you should know.
5+
6+
## Getting started
7+
8+
*[Almost]* Every subdirectory has a markdown file with explanations on how code is
9+
structured and designed in that layer. It will give you a brief overview of what the layer
10+
is, and then walk you through on how to contribute to it. You can use the table below to
11+
quickly navigate to any of them.
12+
13+
- [Datamodels](/src/main/kotlin/com/daymxn/dchat/datamodel/DATAMODELS.md)
14+
- [Routes](/src/main/kotlin/com/daymxn/dchat/routes/ROUTES.md)
15+
- [WebSockets](/src/main/kotlin/com/daymxn/dchat/routes/websockets/WEBSOCKETS.md)
16+
- [Services](/src/main/kotlin/com/daymxn/dchat/service/SERVICES.md)
17+
- [Tests](/src/test/TESTS.md)
18+
19+
## Making changes
20+
21+
To make changes, clone the repo to your local disk
22+
23+
`git clone [email protected]:daymxn/dChat.git`
24+
25+
Then, checkout to a new feature branch labeled in the following format
26+
27+
`git checkout -b NAME-CATEGORY-FEATURE`
28+
29+
Where `NAME` is your *firstLast* name or your *github* username. `CATEGORY` is something like; feature or bugfix.
30+
And `FEATURE` is the title of the new feature (or bug) you're contributing for.
31+
32+
After you've made changes to your local branch, and you want to submit, you can open a Pull Request (PR)
33+
via the [GitHub web panel](https://github.com/daymxn/dChat/compare).
34+
35+
> Note that making public contributions to this repo means you accept the LICENSE in place, and are contributing code that also respects that same license
36+
37+
### Code Formatting
38+
39+
Code in this repo is formatted with the ktfmt tool for google-java-format. You can enable
40+
this formatting in IntelliJ by downloading and installing the
41+
[ktfmt plugin](https://github.com/facebookincubator/ktfmt).

gradle.properties

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
ktorVersion=2.0.0
2+
kotlinVersion=1.6.20
3+
logbackVersion=1.2.11
4+
kotlin.code.style=official
5+
exposedVersion=0.37.3
6+
kotestVersion=5.2.2
7+
mockkVersion=1.12.3
8+

gradle/wrapper/gradle-wrapper.jar

58.1 KB
Binary file not shown.
+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-7.1-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

gradlew

+185
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
#!/usr/bin/env sh
2+
3+
#
4+
# Copyright 2015 the original author or 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+
19+
##############################################################################
20+
##
21+
## Gradle start up script for UN*X
22+
##
23+
##############################################################################
24+
25+
# Attempt to set APP_HOME
26+
# Resolve links: $0 may be a link
27+
PRG="$0"
28+
# Need this for relative symlinks.
29+
while [ -h "$PRG" ] ; do
30+
ls=`ls -ld "$PRG"`
31+
link=`expr "$ls" : '.*-> \(.*\)$'`
32+
if expr "$link" : '/.*' > /dev/null; then
33+
PRG="$link"
34+
else
35+
PRG=`dirname "$PRG"`"/$link"
36+
fi
37+
done
38+
SAVED="`pwd`"
39+
cd "`dirname \"$PRG\"`/" >/dev/null
40+
APP_HOME="`pwd -P`"
41+
cd "$SAVED" >/dev/null
42+
43+
APP_NAME="Gradle"
44+
APP_BASE_NAME=`basename "$0"`
45+
46+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
47+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
48+
49+
# Use the maximum available, or set MAX_FD != -1 to use that value.
50+
MAX_FD="maximum"
51+
52+
warn () {
53+
echo "$*"
54+
}
55+
56+
die () {
57+
echo
58+
echo "$*"
59+
echo
60+
exit 1
61+
}
62+
63+
# OS specific support (must be 'true' or 'false').
64+
cygwin=false
65+
msys=false
66+
darwin=false
67+
nonstop=false
68+
case "`uname`" in
69+
CYGWIN* )
70+
cygwin=true
71+
;;
72+
Darwin* )
73+
darwin=true
74+
;;
75+
MSYS* | MINGW* )
76+
msys=true
77+
;;
78+
NONSTOP* )
79+
nonstop=true
80+
;;
81+
esac
82+
83+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
84+
85+
86+
# Determine the Java command to use to start the JVM.
87+
if [ -n "$JAVA_HOME" ] ; then
88+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
89+
# IBM's JDK on AIX uses strange locations for the executables
90+
JAVACMD="$JAVA_HOME/jre/sh/java"
91+
else
92+
JAVACMD="$JAVA_HOME/bin/java"
93+
fi
94+
if [ ! -x "$JAVACMD" ] ; then
95+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
96+
97+
Please set the JAVA_HOME variable in your environment to match the
98+
location of your Java installation."
99+
fi
100+
else
101+
JAVACMD="java"
102+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
103+
104+
Please set the JAVA_HOME variable in your environment to match the
105+
location of your Java installation."
106+
fi
107+
108+
# Increase the maximum file descriptors if we can.
109+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
110+
MAX_FD_LIMIT=`ulimit -H -n`
111+
if [ $? -eq 0 ] ; then
112+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
113+
MAX_FD="$MAX_FD_LIMIT"
114+
fi
115+
ulimit -n $MAX_FD
116+
if [ $? -ne 0 ] ; then
117+
warn "Could not set maximum file descriptor limit: $MAX_FD"
118+
fi
119+
else
120+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
121+
fi
122+
fi
123+
124+
# For Darwin, add options to specify how the application appears in the dock
125+
if $darwin; then
126+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
127+
fi
128+
129+
# For Cygwin or MSYS, switch paths to Windows format before running java
130+
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
131+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
132+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
133+
134+
JAVACMD=`cygpath --unix "$JAVACMD"`
135+
136+
# We build the pattern for arguments to be converted via cygpath
137+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
138+
SEP=""
139+
for dir in $ROOTDIRSRAW ; do
140+
ROOTDIRS="$ROOTDIRS$SEP$dir"
141+
SEP="|"
142+
done
143+
OURCYGPATTERN="(^($ROOTDIRS))"
144+
# Add a user-defined pattern to the cygpath arguments
145+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
146+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
147+
fi
148+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
149+
i=0
150+
for arg in "$@" ; do
151+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
152+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
153+
154+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
155+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
156+
else
157+
eval `echo args$i`="\"$arg\""
158+
fi
159+
i=`expr $i + 1`
160+
done
161+
case $i in
162+
0) set -- ;;
163+
1) set -- "$args0" ;;
164+
2) set -- "$args0" "$args1" ;;
165+
3) set -- "$args0" "$args1" "$args2" ;;
166+
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
167+
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
168+
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
169+
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
170+
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
171+
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
172+
esac
173+
fi
174+
175+
# Escape application args
176+
save () {
177+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
178+
echo " "
179+
}
180+
APP_ARGS=`save "$@"`
181+
182+
# Collect all arguments for the java command, following the shell quoting and substitution rules
183+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
184+
185+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)