Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rexlx/scream
chat application. go, htmx, bbolt db, bulma css.
https://github.com/rexlx/scream
bbolt bulma-css go htmx websocket
Last synced: 23 days ago
JSON representation
chat application. go, htmx, bbolt db, bulma css.
- Host: GitHub
- URL: https://github.com/rexlx/scream
- Owner: rexlx
- License: mit
- Created: 2024-07-13T00:13:42.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T20:24:14.000Z (2 months ago)
- Last Synced: 2024-10-02T05:41:44.126Z (about 1 month ago)
- Topics: bbolt, bulma-css, go, htmx, websocket
- Language: Go
- Homepage:
- Size: 14.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# screamery
### a chat app
go / htmx / bbolt / bulma.
## features
- local authentication
- create posts for your profile
- comment on other users posts
- message sanitization
- local db (bbolt)
- messages are only stored in memory (never written to disk)
- send "commands" to the server (see help page)
- a help page
- stats and graphs, if you're into that kind of thing
## install and run
`go build . # in root directory`
```
./scream -h
Usage of ./scream:
-cert-file string
cert file (default "server-cert.pem")
-chart-service-log string
chart service log (default "charting_service.log")
-chart-service-port string
chart service port (default ":10440")
-chart-service-url string
chart service url (default "http://localhost:10440/graph")
-db-name string
database name (default "chat.db")
-first-user-mode
first user mode
-key-file string
key file (default "server-key.pem")
-log-file string
log file (default "chat.log")
-message-limit int
message limit (default 100)
-self-host
self host microservice (default true)
-token-bucket string
token bucket (default "tokens")
-update-freq duration
update frequency (default 2m0s)
-url string
url (default ":8081")
-user-bucket string
user bucket (default "users")
```
### endpoints
- localhost:8080/add-user to add first user.
- /help for help
- / to hit login
- /room/whatever to create a new room
- /stats to see the charts
## example
