Files
chookchat/README.md
2026-07-24 08:39:28 +10:00

43 lines
1.0 KiB
Markdown

# Chookchat
This is a simple message board
Features:
- Username/password access (passwords secured by bcrypt2)
- Markdown rendering
- User profile pages
- Friends (direct messages system) (WIP)
## Building
Install `bin2cpp` and `maddy`.
Then, do the following:
```sh
# serialises the client using bin2cpp
sh build.sh
cd server
meson setup builddir
meson compile -C builddir
# run with
./builddir/chookchat
```
## Credits
The server uses the following libraries:
- [cpp-httplib](https://github.com/yhirose/cpp-httplib) for the web server
- [Maddy](https://github.com/progsource/maddy) for the Markdown processor
- [Bcrypt.cpp](https://github.com/hilch/Bcrypt.cpp) for password hashing/salting
- [bin2cpp](https://github.com/end2endzone/bin2cpp) for packing site files into the binary
The following people have contributed to the project:
- [SpookyDervish](https://chookspace.com/SpookyDervish) for client navbar and notification sound
- [reallynniroprobably](https://chookspace.com/reallynniroprobably) for error message