max/chookchat
max/chookchat
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity
A simple messaging service https://maxwellj.xyz/chookchat
19 Commits 1 Branch 2 Tags 615 KiB
Kotlin 41.9%
JavaScript 35.5%
CSS 14.2%
HTML 8.4%
0.0.2
Go to file
Maxwell Jeffress d839652916 Clean up code, support JSON
2024-11-23 18:12:07 +11:00
client-cli Add web client, update CLI client 2024-11-05 20:35:10 +11:00
client-web Update some CSS, support JSON 2024-11-23 18:10:56 +11:00
server Clean up code, support JSON 2024-11-23 18:12:07 +11:00
.gitignore Base server on Javalin for easy future development 2024-10-23 14:25:25 +11:00
LICENSE Initial commit 2024-10-16 08:29:12 +11:00
README.md Update readme 2024-11-05 20:41:44 +11:00

README.md

Chookpen - A simple messaging service

What is Chookpen?

Chookpen is a lightweight, secure-ish chat server implementation focused on simplicity and real-time communication. It features user authentication, persistent message history, real-time updates via WebSockets, and supports both traditional HTTP endpoints and WebSocket connections for flexible integration. It uses very little resources on a system, often using a maximum of 20mb. Chookpen is BETA SOFTWARE, and MAY BE BUGGY! Don't expect too much.

A guide to this repository

Chookpen is split up into multiple parts, the server and different reference clients for different platforms. For extensive documentation of all parts of Chookpen, a repository wiki is being worked on which will be released soon. For now, if you want to learn more about Chookpen, visit each folder.

Acknowledgments

Chookpen relies on a lot of FOSS software, and wouldn't be possible without it! Here's some quick links to the original projects if you're interested:

Javalin

An easy to use web server for Kotlin and Java. Chookpen wouldn't be possible without it!

Gradle

The build tool for compiling Chookpen. It just works!

Kotlin

The language Chookpen is coded in. How else does it work?

OpenJDK