2017-04-03 08:44:19 +00:00
|
|
|
# Bulletin Butter & Jelly
|
2017-04-03 04:53:08 +00:00
|
|
|
|
2017-04-29 03:11:35 +00:00
|
|
|
BBJ is a trivial collection of python scripts and database queries that
|
|
|
|
|
miraculously shit out a fully functional, text-driven community bulletin board.
|
2017-09-06 22:05:19 +00:00
|
|
|
Requires Python 3.4 and up for the server and the official TUI client (clients/urwid/).
|
2017-04-29 03:07:18 +00:00
|
|
|
|
|
|
|
|
|
2022-01-16 03:54:16 +00:00
|
|
|
<div style="text-align: center;"><h2>Look Ma, it boots !!11!</h2></div>
|
2017-04-29 03:11:35 +00:00
|
|
|
|
2022-01-16 03:54:16 +00:00
|
|
|
It's all driven by an API sitting on top of CherryPy. Currently, it does not
|
2017-04-29 03:11:35 +00:00
|
|
|
serve HTML but this is planned for the (distant?) future.
|
|
|
|
|
|
2022-01-16 03:54:16 +00:00
|
|
|
The two official client implementations are a standalone TUI client for
|
2017-04-29 03:11:35 +00:00
|
|
|
the unix terminal, and GNU Emacs. The API is simple and others are welcome
|
|
|
|
|
to join the party at some point.
|
2022-01-16 03:54:16 +00:00
|
|
|
|
|
|
|
|
## Setup Instructions
|
|
|
|
|
|
|
|
|
|
1. Make a virtual env
|
|
|
|
|
```
|
|
|
|
|
python3 -m venv venv
|
|
|
|
|
source venv/bin/activate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
2. Run setup.sh
|
|
|
|
|
```
|
|
|
|
|
./setup.sh venv/bin/python3
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
3. Add systemd service (optional)
|
|
|
|
|
```
|
|
|
|
|
cp contrib/bbj.service /etc/systemd/system/
|
|
|
|
|
$EDITOR /etc/systemd/system/bbj.service
|
|
|
|
|
systemctl enable --now bbj
|
|
|
|
|
```
|
|
|
|
|
Be sure to edit bbj.service with your venv and paths.
|
|
|
|
|
|
|
|
|
|
4. Make a client script
|
|
|
|
|
|
|
|
|
|
Create a script somewhere in your `$PATH` (I used `/usr/local/bin/bbj`) with the following contents,
|
|
|
|
|
adapting the path to your install:
|
|
|
|
|
```shell
|
|
|
|
|
#!/bin/sh
|
|
|
|
|
exec /srv/bbj/venv/bin/python3 /srv/bbj/clients/urwid/main.py
|
|
|
|
|
```
|
