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
16$ git clone https://tangled.org/emmeline.girlkisser.top/beep
17$ cd beep
18$ cp config.maple config.real.maple
19
20Edit config.real.maple to set ports, auth, etc.
21
22`config.real.maple` also has settings to configure the
23default theme, post length, username length, welcome
24messages, etc etc.
25
26[WARNING] DO NOT PUT SECRETS IN config.maple
27config.maple is intended to be pushed to Git as a template
28config for your instance. Instead, put your secrets in
29config.real.maple, which is gitignored.
30TODO: Read secrets from .env automatically.
31
32With Docker:
33 $ docker compose up
34
35Without Docker:
36 (assumes you already have a database somewhere)
37 $ v install EmmaTheMartian.Maple
38 $ v -prod .
39 $ ./beep config.real.maple
40
41 If `v install ...` fails then you can install Maple
42 manually:
43 $ mkdir -p ~/.vmodules/emmathemartian/maple
44 $ git clone https://github.com/emmathemartian/maple ~/.vmodules/emmathemartian/maple