PostText/README.md

83 lines
1.7 KiB
Markdown
Raw Normal View History

2022-07-22 17:34:36 -04:00
# Post::Text
2022-07-22 17:22:23 -04:00
A textboard written in Perl
2022-07-22 17:34:36 -04:00
## Installing locally
2022-10-01 22:43:40 -04:00
Install dependencies:
cpanm --installdeps .
2022-07-22 18:43:01 -04:00
## Running locally
2022-10-01 22:43:40 -04:00
Create a config file:
cp example_post_text.conf post_text.conf
This file right now just contains a Perl hash reference. Someday it
should be YAML or XML or something better suited.
Run it in development mode:
2022-07-22 18:43:01 -04:00
2023-05-14 22:43:13 -04:00
morbo -w assets/css/ -w public/ -w lib/ -w templates/ \
-w script/ script/post_text
2022-07-22 18:43:01 -04:00
Now try requesting http://localhost:3000
## Testing
First, create a valid first thread and first remark to the first
thread. The tests rely on the existence of thread #1 and remark #1
being the first remark to that first thread. Then you can run the
tests locally:
2022-07-22 18:43:01 -04:00
prove -l
2022-07-22 18:43:01 -04:00
2023-04-25 15:10:31 -04:00
## Building/running container
### Build
podman build -t post_text .
### Tag
2023-07-26 12:39:14 -04:00
podman tag post_text git.minimally.online/swaggboi/post_text
2023-04-25 15:10:31 -04:00
### Push
2023-07-26 12:39:14 -04:00
podman push git.minimally.online/swaggboi/post_text
2023-04-25 15:10:31 -04:00
### Pull
2023-07-26 12:39:14 -04:00
podman pull git.minimally.online/swaggboi/post_text
2023-04-25 15:10:31 -04:00
### Run
podman run -dt --rm --name post_text -p 3002:3000 post_text
2023-04-25 15:10:31 -04:00
### Generate unit file
podman generate systemd --files --new --name post_text
2022-07-22 17:34:36 -04:00
## TODOs
2023-08-17 13:03:29 -04:00
1. Full text search + archive old posts
2023-01-08 22:11:46 -05:00
1. "All new posts flagged" mode (require approval for new posts)
1. Tests for mod-only user?
2022-09-01 16:00:54 -04:00
## Crazy future ideas
### (Lord knows there's TODOs I could be working on...)
1. Is `remark_tally` counting hidden remarks? Tried to add a `WHERE
NOT hidden_status` but that returns null, probably need a different
`JOIN` which may not be worth the trouble/processing
1. Implement tripcodes (moving this down in priority due to complexity...)
2022-09-01 16:00:54 -04:00
1. Post thread via SMS (twil.io??)
2023-08-14 20:40:38 -04:00
## AGPL-3.0+ANTIFA compliance
- Antifa
- Trans Rights
- Black Lives Matter