PostText/README.md

79 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
morbo -w assets/css/ -w lib/ -w migrations/ -w t/ -w templates/ \
script/post_text
2022-07-22 18:43:01 -04:00
Now try requesting http://localhost:3000
## Testing
2022-10-01 22:43:40 -04:00
Run the tests locally (against development environment):
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
podman tag post_text git.n4vn33t.com/swag/post_text
### Push
podman push git.n4vn33t.com/swag/post_text
### Pull
podman pull git.n4vn33t.com/swag/post_text
### 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
2022-09-21 01:29:49 -04:00
1. CSS
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?
1. Check input validation
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-26 23:51:36 -04:00
1. Return a text response instead of HTML if a `.txt` extension [is
requested](https://docs.mojolicious.org/Mojolicious/Plugin/DefaultHelpers#respond_to)
2022-10-06 12:13:20 -04:00
(JSON?)
2022-09-01 16:00:54 -04:00
1. Post thread via SMS (twil.io??)
1. Option to remark without bumping?