wip
This commit is contained in:
parent
5deba2fdb1
commit
9fe5d3c70e
45 changed files with 5311 additions and 815 deletions
27
README.md
27
README.md
|
|
@ -9,12 +9,27 @@ Rust webserver for comments, that you can easily embed in a website.
|
|||
* List and post comments by topic (e.g. each article in your blog is a topic)
|
||||
* Admin approval
|
||||
* Admin notification on new comment via Matrix
|
||||
* Embedded one-file webserver
|
||||
* Single-file webserver, WASM client for browsers
|
||||
* Customizable [Tera](https://github.com/Keats/tera) templates
|
||||
* Comment frequency limit per IP
|
||||
* i18n
|
||||
* Petnames! (anonymous comment authors get a funny random name)
|
||||
* Designed for privacy and moderation
|
||||
* JSON API
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
# Install trunk
|
||||
cargo install trunk
|
||||
|
||||
# Run server
|
||||
cargo run --release -- start
|
||||
|
||||
# Build and serve client
|
||||
cd webui
|
||||
trunk serve --release
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
|
|
@ -47,16 +62,6 @@ Uses no cookie, no unique user identifier. At each mutation (i.e. new comment or
|
|||
|
||||
However, keep in mind that if a reverse proxy (or any other intermediate tool) is used, IP addresses and other metadata may be logged somewhere.
|
||||
|
||||
## API
|
||||
|
||||
/api/post_comment
|
||||
/api/comments_by_topic
|
||||
/api/edit_comment
|
||||
/api/remove_comment
|
||||
/api/get_comment
|
||||
/api/admin/approve_comment
|
||||
/api/admin/remove_comment
|
||||
|
||||
## License
|
||||
|
||||
CopyLeft 2022-2023 Pascal Engélibert [(why copyleft?)](https://txmn.tk/blog/why-copyleft/)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue