a mini social media app for small communities
1
2beep
3====
4
5> *a legendary land of lowercase lovers.*
6
7A self-hosted "social-media-oriented" mini-blogger.
8
9Technically made because I wanted to mess around with RSS,
10but I also wanted a teensy little blog/slow-paced-chat-app
11for myself and my friends.
12
13hosting
14-------
15
16You'll need a PostgreSQL database somewhere, along with V
17to compile beep:
18
19$ git clone https://github.com/emmathemartian/beep
20$ cd beep
21$ v -prod .
22
23Copy the `config.maple` as `config.real.maple`
24
25$ cp config.maple config.real.maple
26
27Edit `config.real.maple` to set the URL, port, DB username,
28password, and name.
29
30`config.real.maple` also has settings to configure the
31default theme, post length, username length, welcome
32messages, etc etc.
33
34WARNING: DO NOT PUT SECRETS IN `config.maple`.
35`config.maple` is intended to be pushed to Git as a
36"template config." Instead, use `config.real.maple` if you
37plan to push anywhere. It's gitignored by default, i.e, an
38accidental exclusion in the gitignore and push won't expose
39your keys.
40
41$ ./beep config.real.maple
42
43Then go to the configured port to view (default is
44`http://localhost:8008`).
45
46If you don't have a database, you can either self-host a
47psql database on your machine, or you can find a free one
48online. I like [neon.tech](https://neon.tech), their free
49plan is pretty comfortable for a small beep instance!