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
29 Commits 1 Branch 2 Tags 615 KiB
Kotlin 41.9%
JavaScript 35.5%
CSS 14.2%
HTML 8.4%
7ff5447388
Go to file
Maxwell Jeffress 7ff5447388 Add eggs, as well as example egg and config
2024-12-06 13:07:53 +11:00
client-web Add Jitsi call button 2024-12-04 08:28:53 +11:00
server Add eggs, as well as example egg and config 2024-12-06 13:07:53 +11:00
.gitignore Add Chookpen config file 2024-12-04 08:39:58 +11:00
LICENSE Initial commit 2024-10-16 08:29:12 +11:00
README.md Update readmes, make slight code change 2024-11-23 19:38:19 +11:00

README.md

Chookchat - A simple messaging service

What is Chookchat?

Chookchat is a lightweight, secure-ish chat server implementation focused on simplicity and real-time communication. It features user authentication, persistent message history and real-time updates via WebSockets. 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

The best way to run Chookpen. Free and open source!

There's also all the other various libraries I use (and these other libraries use) so check the code for those!